Skip to content

Commit 0ccf569

Browse files
authored
docs: improve options section (#603)
1 parent 1b48dee commit 0ccf569

File tree

1 file changed

+11
-1
lines changed

1 file changed

+11
-1
lines changed

README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -326,8 +326,14 @@ Components({
326326

327327
// valid file extensions for components.
328328
extensions: ['vue'],
329+
330+
// Glob patterns to match file names to be detected as components.
331+
// When specified, the `dirs` and `extensions` options will be ignored.
332+
globs: ['src/components/*.{vue}'],
333+
329334
// search for subdirectories
330335
deep: true,
336+
331337
// resolvers for custom components
332338
resolvers: [],
333339

@@ -343,6 +349,7 @@ Components({
343349
// to prevent duplication inside namespaced component name.
344350
// works when `directoryAsNamespace: true`
345351
collapseSamePrefixes: false,
352+
346353
// Subdirectory paths for ignoring namespace prefixes.
347354
// works when `directoryAsNamespace: true`
348355
globalNamespaces: [],
@@ -365,7 +372,10 @@ Components({
365372

366373
// Vue version of project. It will detect automatically if not specified.
367374
// Acceptable value: 2 | 2.7 | 3
368-
version: 2.7
375+
version: 2.7,
376+
377+
// Only provide types of components in library (registered globally)
378+
types: []
369379
})
370380
```
371381

0 commit comments

Comments
 (0)