feat(dev): add global component types for volar (element-plus#3624)

* feat(dev): add global component types for volar * chore: update README.md
StetroF · Sep 25, 2021 · 5faec88 · 5faec88
1 parent ad32cba
commit 5faec88
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -137,6 +137,8 @@ $ pnpm gen component-name
 
 Note the `component-name` must be in `kebab-case`, combining words by replacing each space with a dash.
 
+And component type must be added to `packages/element-plus/global.d.ts`.
+
 ## Commit template
 
 With command

diff --git a/docs/en-US/guide/quickstart.md b/docs/en-US/guide/quickstart.md
@@ -25,6 +25,20 @@ app.use(ElementPlus)
 app.mount('#app')
 ```
 
+#### Volar support
+
+If you use volar, please add the global component type definition to `compilerOptions.types` in `tsconfig.json`.
+
+```json
+// tsconfig.json
+{
+  "compilerOptions": {
+    // ...
+    "types": ["element-plus/global"]
+  }
+}
+```
+
 ### On-demand Import
 
 You need to use an additional plugin to import components you used.

diff --git a/typings/components.d.ts → packages/element-plus/global.d.ts b/typings/components.d.ts → packages/element-plus/global.d.ts