Skip to content

Commit cbe7b33

Browse files
docs: update configuration and examples (#400)
Co-authored-by: Anthony Fu <[email protected]>
1 parent cda2ffb commit cbe7b33

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ Components({
176176

177177
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.
178178

179-
**Make sure you also add `components.d.ts` to your `tsconfig.json` under `includes`.**
179+
> **Make sure you also add `components.d.ts` to your `tsconfig.json` under `includes`.**
180180
181181
## Importing from UI Libraries
182182

@@ -342,6 +342,12 @@ Components({
342342
// To install Babel, run: `npm install -D @babel/parser @babel/traverse`
343343
directives: true,
344344

345+
// Transform path before resolving
346+
importPathTransform: v => v,
347+
348+
// Allow for components to override other components with the same name
349+
allowOverrides: false,
350+
345351
// filters for transforming targets
346352
include: [/\.vue$/, /\.vue\?vue/],
347353
exclude: [/[\\/]node_modules[\\/]/, /[\\/]\.git[\\/]/, /[\\/]\.nuxt[\\/]/],
@@ -350,7 +356,7 @@ Components({
350356

351357
## Example
352358

353-
See the [Vitesse](https://github.com/antfu/vitesse) starter template.
359+
[Vitesse](https://github.com/antfu/vitesse) starter template.
354360

355361
## Thanks
356362

0 commit comments

Comments
 (0)