8000 docs: remove vue 3 only warnings (#4736) · vueuse/vueuse@c6def8b · GitHub
[go: up one dir, main page]

Skip to content

Commit c6def8b

Browse files
authored
docs: remove vue 3 only warnings (#4736)
1 parent 1c60c68 commit c6def8b

File tree

7 files changed

+3
-24
lines changed

7 files changed

+3
-24
lines changed

packages/core/createTemplatePromise/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,6 @@ outline: deep
77

88
Template as Promise. Useful for constructing custom Dialogs, Modals, Toasts, etc.
99

10-
::: warning
11-
This function only works for Vue 3
12-
:::
13-
1410
## Usage
1511

1612
```vue

packages/core/useCurrentElement/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,6 @@ const el = useCurrentElement(componentRef) // ComputedRef<Element>
3434
</template>
3535
```
3636

37-
::: info
38-
Only works for Vue 3 because it uses [computedWithControl](https://vueuse.org/shared/computedWithControl/#manual-triggering) under the hood
39-
:::
40-
4137
## Caveats
4238

4339
This functions uses [`$el` under the hood](https://vuejs.org/api/component-instance.html#el).

packages/core/useCurrentElement/index.test.ts

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,6 @@ import { describe, expect, it } from 'vitest'
33
import { defineComponent, shallowRef } from 'vue'
44
import { useCurrentElement } from './index'
55

6-
// Manual triggering only works for Vue 3 - https://vueuse.org/shared/computedWithControl/#manual-triggering
76
describe('useCurrentElement', () => {
87
it('should be defined', () => {
98
expect(useCurrentElement).toBeDefined()

packages/core/useTemplateRefsList/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,6 @@ category: Component
66

77
Shorthand for binding refs to template elements and components inside `v-for`.
88

9-
::: warning
10-
This function only works for Vue 3
11-
:::
12-
139
## Usage
1410

1511
```vue

packages/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,8 @@ features:
2727
- title: Feature Rich
2828
details: 200+ functions for you to choose from
2929
icon: 🎛
30-
- title: Seamless migration
31-
details: Works for both Vue 3 and 2
30+
- title: Built for Vue 3
31+
details: Designed for Vue 3 to take full advantage of its latest capabilities
3232
icon: 🚀
3333
- title: Fully tree shakeable
3434
details: Only take what you want

packages/router/README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,7 @@
22

33
[![NPM version](https://img.shields.io/npm/v/@vueuse/router?color=a1b858)](https://www.npmjs.com/package/@vueuse/router)
44

5-
> This is an add-on of [VueUse](https://github.com/vueuse/vueuse), providing utilities for vue-router (Vue 3 only).
6-
7-
::: warning
8-
This package only works for Vue 3
9-
:::
5+
> This is an add-on of [VueUse](https://github.com/vueuse/vueuse), providing utilities for vue-router.
106
117
## Install
128

packages/shared/refWithControl/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,6 @@ related: computedWithControl
88

99
Fine-grained controls over ref and its reactivity.
1010

11-
::: warning
12-
This function only works for Vue 3
13-
:::
14-
1511
## Usage
1612

1713
`refWithControl` uses `extendRef` to provide two extra functions `get` and `set` to have better control over when it should track/trigger the reactivity.

0 commit comments

Comments
 (0)
0