Skip to content

Commit ddb7b69

Browse files
committed
chore: update readme
1 parent b038ba9 commit ddb7b69

File tree

1 file changed

+20
-4
lines changed

1 file changed

+20
-4
lines changed

README.md

Lines changed: 20 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,8 @@ export default {
102102
}
103103
```
104104

105+
Once the setup is done, a `components.d.ts` will be generated and updates automatically with the type definitions. Feel free to commit it into git or not as you want.
106+
105107
## Vue 2 Support
106108

107109
It just works.
@@ -121,7 +123,18 @@ export default {
121123

122124
## Importing from UI Libraries
123125

124-
We have several built-in resolver for popular UI libraries like [Ant Design Vue](https://antdv.com/) and [Element Plus](https://element-plus.org/), where you can enable them by:
126+
We have several built-in resolvers for popular UI libraries like **Vuetify**, **Ant Design Vue**, and **Element Plus**, where you can enable them by:
127+
128+
Supported Resolvers:
129+
130+
- [Ant Design Vue](https://github.com/antfu/vite-plugin-components/blob/master/src/resolvers/antdv.ts)
131+
- [Element Plus](https://github.com/antfu/vite-plugin-components/blob/master/src/resolvers/element-plus.ts)
132+
- [Headless UI](https://github.com/antfu/vite-plugin-components/blob/master/src/resolvers/headless-ui.ts)
133+
- [Native UI](https://github.com/antfu/vite-plugin-components/blob/master/src/resolvers/naive-ui.ts)
134+
- [Vant](https://github.com/antfu/vite-plugin-components/blob/master/src/resolvers/vant.ts)
135+
- [Varlet UI](https://github.com/antfu/vite-plugin-components/blob/master/src/resolvers/varlet-ui.ts)
136+
- [Vuetify](https://github.com/antfu/vite-plugin-components/blob/master/src/resolvers/vuetify.ts)
137+
- [VueUse Components](https://github.com/antfu/vite-plugin-components/blob/master/src/resolvers/vueuse.ts)
125138

126139
```ts
127140
// vite.config.js
@@ -145,7 +158,7 @@ export default {
145158
}
146159
```
147160

148-
Or you can write your own resolver quite easily:
161+
You can also write your own resolver easily:
149162

150163
```ts
151164
// vite.config.js
@@ -168,8 +181,7 @@ export default {
168181
}
169182
```
170183

171-
If made other UI libraries configured, please feel free to contribute so it can help others using them out-of-box. Thanks!
172-
184+
If you made other UI libraries configured, please feel free to contribute so it can help others using them out-of-box. Thanks!
173185

174186
## Configuration
175187

@@ -185,6 +197,10 @@ ViteComponents({
185197
// search for subdirectories
186198
deep: true,
187199

200+
// generate `components.d.ts` global declrations,
201+
// also accepts a path for custom filename
202+
globalComponentsDeclaration: false,
203+
188204
// Allow subdirectories as namespace prefix for components.
189205
directoryAsNamespace: false,
190206
// Subdirectory paths for ignoring namespace prefixes

0 commit comments

Comments
 (0)