diff --git a/README.md b/README.md index 34a2e7aba754acb277ad5e9cdfac771bfd13f079..1701ac4fac59747d321a182436f4fc0ffc7bcfa9 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@

- DevUI Logo + DevUI Logo

@@ -8,6 +8,10 @@ Vue DevUI 是 Vue3 版本的 DevUI 组件库,基于 [https://github.com/devclo DevUI 官方网站:[https://devui.design](https://devui.design) +DevUI开源项目正在参加[2021年度OSC中国开源项目评选](https://www.oschina.net/project/top_cn_2021/?id=205&ticket=4b10864b99e57311d9897964acfc0c9c),欢迎大家给我们`DevUI Design`投上宝贵的一票: + +[DevUI开源项目-2021年度OSC中国开源项目评选投票](https://www.oschina.net/project/top_cn_2021/?id=205&ticket=4b10864b99e57311d9897964acfc0c9c) + 想了解[DevUI](https://devui.design)开源的故事,可以阅读以下文章: [DevUI开源的故事](https://juejin.cn/post/7029092585452863525/) @@ -70,6 +74,7 @@ yarn add vue-devui ## 2. 全量引入 +在`main.ts`文件中编写以下代码: ``` import { createApp } from 'vue' import App from './App.vue' @@ -88,6 +93,7 @@ createApp(App) 除了全量引入,我们也支持单个组件按需引入。 +在`main.ts`文件中编写以下代码: ``` import { createApp } from 'vue' import App from './App.vue' @@ -103,7 +109,32 @@ createApp(App) .mount('#app') ``` -## 4. 使用 +## 4. 配置自动按需引入`unplugin-vue-components`(推荐) + +配置`unplugin-vue-components`插件可以无需引入Vue DevUI就可以直接按需使用其中的组件,具体使用方式如下: + +在`vite.config.ts`文件中添加以下代码: +``` +import Components from 'unplugin-vue-components/vite' +import { DevUiResolver } from 'unplugin-vue-components/resolvers' + +export default defineConfig({ + plugins: [ + vue(), + + // 新增 + Components({ + resolvers: [ + DevUiResolver() + ] + }) + ] +}) +``` + +配置了以上插件,就可以直接在代码中使用`Vue DevUI`的组件,而无需在`main.ts`文件中引入`Vue DevUI`。 + +## 5. 使用 ```