Skip to content

Commit 8f97d4d

Browse files
sxzzsxzz
committed
docs: improve volar plugin
closes #229
1 parent cf20f6f commit 8f97d4d

File tree

11 files changed

+62
-62
lines changed

11 files changed

+62
-62
lines changed

‎docs/features/better-define.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ With enabling `betterDefine`, imported types are supported in `<script setup>` t
66

77
[Related issue](https://github.com/vuejs/core/issues/4294)
88

9-
| Features | Supported |
10-
| :----------------: | :----------------: |
11-
| Vue 3 | :white_check_mark: |
12-
| Nuxt 3 | :white_check_mark: |
13-
| Vue 2 | :white_check_mark: |
14-
| TypeScript / Volar | :white_check_mark: |
9+
| Features | Supported |
10+
| :--------: | :----------------: |
11+
| Vue 3 | :white_check_mark: |
12+
| Nuxt 3 | :white_check_mark: |
13+
| Vue 2 | :white_check_mark: |
14+
| TypeScript | :white_check_mark: |
1515

1616
## Basic Usage
1717

‎docs/features/export-props.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
[Svelte-like Declaring props](https://svelte.dev/docs#component-format-script-1-export-creates-a-component-prop) for Vue.
66

7-
| Features | Supported |
8-
| :----------------: | :----------------: |
9-
| Vue 3 | :white_check_mark: |
10-
| Nuxt 3 | ? |
11-
| Vue 2 | ? |
12-
| TypeScript / Volar | :white_check_mark: |
7+
| Features | Supported |
8+
| :----------: | :----------------: |
9+
| Vue 3 | :white_check_mark: |
10+
| Nuxt 3 | ? |
11+
| Vue 2 | ? |
12+
| Volar Plugin | :white_check_mark: |
1313

1414
## Usage
1515

‎docs/features/hoist-static.md‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,11 @@ With enabling `hoistStatic`, constants declared in macros of `<script setup>` ca
66

77
If you support this feature, feel free to hit like :+1: or comment on the [Vue PR](https://github.com/vuejs/core/pull/5752). Thanks!
88

9-
| Features | Supported |
10-
| :----------------: | :----------------: |
11-
| Vue 3 | :white_check_mark: |
12-
| Nuxt 3 | :white_check_mark: |
13-
| Vue 2 | :white_check_mark: |
14-
| TypeScript / Volar | :white_check_mark: |
9+
| Features | Supported |
10+
| :------: | :----------------: |
11+
| Vue 3 | :white_check_mark: |
12+
| Nuxt 3 | :white_check_mark: |
13+
| Vue 2 | :white_check_mark: |
1514

1615
## Basic Usage
1716

‎docs/guide/bundler-integration.md‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,9 @@ npm i -D @vue-macros/volar
137137
"plugins": [
138138
"@vue-macros/volar/define-model",
139139
"@vue-macros/volar/define-props",
140-
"@vue-macros/volar/short-vmodel"
141-
// ...more feature
140+
"@vue-macros/volar/short-vmodel",
141+
"@vue-macros/volar/define-slots",
142+
"@vue-macros/volar/export-props"
142143
]
143144
// ...
144145
}

‎docs/macros/define-model.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
Declaring and mutate `v-model` props as the same as normal variable using the `defineModel`.
66

7-
| Features | Supported |
8-
| :----------------: | :----------------: |
9-
| Vue 3 | :white_check_mark: |
10-
| Nuxt 3 | :white_check_mark: |
11-
| Vue 2 | :white_check_mark: |
12-
| TypeScript / Volar | :white_check_mark: |
7+
| Features | Supported |
8+
| :----------: | :----------------: |
9+
| Vue 3 | :white_check_mark: |
10+
| Nuxt 3 | :white_check_mark: |
11+
| Vue 2 | :white_check_mark: |
12+
| Volar Plugin | :white_check_mark: |
1313

1414
## Options
1515

‎docs/macros/define-options.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ Options API can be declared using the `defineOptions` in `<script setup>`, speci
66

77
If you support this feature, feel free to hit like :+1: or comment on the [RFC Discussion](https://github.com/vuejs/rfcs/discussions/430). Thanks!
88

9-
| Features | Supported |
10-
| :----------------: | :----------------: |
11-
| Vue 3 | :white_check_mark: |
12-
| Nuxt 3 | :white_check_mark: |
13-
| Vue 2 | :white_check_mark: |
14-
| TypeScript / Volar | :white_check_mark: |
9+
| Features | Supported |
10+
| :--------: | :----------------: |
11+
| Vue 3 | :white_check_mark: |
12+
| Nuxt 3 | :white_check_mark: |
13+
| Vue 2 | :white_check_mark: |
14+
| TypeScript | :white_check_mark: |
1515

1616
## Installation Standalone Version
1717

‎docs/macros/define-props.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,12 @@ Correct types of destructured props using `$defineProps`.
66

77
See also [Vue issue](https://github.com/vuejs/core/issues/6876), [Reactivity Transform RFC](https://github.com/vuejs/rfcs/blob/reactivity-transform/active-rfcs/0000-reactivity-transform.md#defineprops-destructure-details).
88

9-
| Features | Supported |
10-
| :----------------: | :----------------: |
11-
| Vue 3 | :white_check_mark: |
12-
| Nuxt 3 | :white_check_mark: |
13-
| Vue 2 | :white_check_mark: |
14-
| TypeScript / Volar | :white_check_mark: |
9+
| Features | Supported |
10+
| :-----------------------: | :----------------: |
11+
| Vue 3 | :white_check_mark: |
12+
| Nuxt 3 | :white_check_mark: |
13+
| Vue 2 | :white_check_mark: |
14+
| TypeScript / Volar Plugin | :white_check_mark: |
1515

1616
::: warning
1717

‎docs/macros/define-render.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44

55
Defining render function in `<script setup>` using the `defineRender`.
66

7-
| Features | Supported |
8-
| :----------------: | :----------------: |
9-
| Vue 3 | :white_check_mark: |
10-
| Nuxt 3 | :white_check_mark: |
11-
| Vue 2 | :white_check_mark: |
12-
| TypeScript / Volar | :white_check_mark: |
7+
| Features | Supported |
8+
| :--------: | :----------------: |
9+
| Vue 3 | :white_check_mark: |
10+
| Nuxt 3 | :white_check_mark: |
11+
| Vue 2 | :white_check_mark: |
12+
| TypeScript | :white_check_mark: |
1313

1414
## Basic Usage
1515

‎docs/macros/define-slots.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44

55
Declaring type of SFC slots in `<script setup>` using the `defineSlots`.
66

7-
| Features | Supported |
8-
| :-----------: | :---------------------------------: |
9-
| Vue 3 | :white_check_mark: |
10-
| Nuxt 3 | :white_check_mark: |
11-
| Vue 2 | :white_check_mark: |
12-
| Volar + Vue 3 | :white_check_mark: |
13-
| Volar + Vue 2 | :x: (Volar does not support it yet) |
7+
| Features | Supported |
8+
| :------------------: | :---------------------------------: |
9+
| Vue 3 | :white_check_mark: |
10+
| Nuxt 3 | :white_check_mark: |
11+
| Vue 2 | :white_check_mark: |
12+
| Volar Plugin + Vue 3 | :white_check_mark: |
13+
| Volar Plugin + Vue 2 | :x: (Volar does not support it yet) |
1414

1515
## Basic Usage
1616

‎docs/macros/short-emits.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,11 @@
44

55
Simplify the definition of emits.
66

7-
| Features | Supported |
8-
| :----------------: | :----------------: |
9-
| Vue 3 | :white_check_mark: |
10-
| Vue 2 | :white_check_mark: |
11-
| TypeScript / Volar | :white_check_mark: |
7+
| Features | Supported |
8+
| :--------: | :----------------: |
9+
| Vue 3 | :white_check_mark: |
10+
| Vue 2 | :white_check_mark: |
11+
| TypeScript | :white_check_mark: |
1212

1313
## Basic Usage
1414

0 commit comments

Comments
 (0)