docs: ✏️ 优化文档快速上手章节

This commit is contained in:
Moonofweisheng 2024-10-08 17:55:19 +08:00
parent 69c17b7c58
commit 4e9a9da914

View File

@ -2,26 +2,16 @@
本节介绍如何在`uni-app`项目中安装、配置并使用 `Wot Design Uni` 本节介绍如何在`uni-app`项目中安装、配置并使用 `Wot Design Uni`
## 安装
:::warning 关于安装 :::warning 关于安装
`Wot Design Uni`提供了`uni_modules``npm`两种安装方式,按需选择。 `Wot Design Uni`提供了`uni_modules``npm`两种安装方式,按需选择。
- 使用`uni_modules`安装无需额外配置,即插即用,但是每次更新组件库需要处理代码差异(一般直接覆盖就可以)。 - 使用`uni_modules`安装无需额外配置,即插即用,但是每次更新组件库需要处理代码差异(一般直接覆盖就可以)。
- 使用`npm`安装需要额外配置,更新组件库时无需处理代码差异。 - 使用`npm`安装需要额外配置,更新组件库时无需处理代码差异。
::: :::
## uni_modules 安装 ### npm 安装
`Wot Design Uni` 支持 [uni_modules](https://uniapp.dcloud.net.cn/plugin/uni_modules.html#uni-modules) 规范,已经上架到 uni-app 的插件市场。
`uni-app插件市场`选择使用`HBuildX`导入或者选择手动在src目录下创建uni_modules文件夹并将`Wot Design Uni`解压到uni_modules中结构如下:
```
- uni_modules
- - - wot-design-uni
```
下载地址:<a href="https://ext.dcloud.net.cn/plugin?id=13889"><span >wot-design-uni</span></a>
## npm 安装
::: code-group ::: code-group
```bash [npm] ```bash [npm]
@ -37,7 +27,28 @@ pnpm add wot-design-uni
``` ```
::: :::
### 配置easycom自动引入组件<el-tag type="primary" style="vertical-align: middle;margin-left:8px;" effect="dark" >自动引入方案1</el-tag>
### uni_modules 安装
`Wot Design Uni` 支持 [uni_modules](https://uniapp.dcloud.net.cn/plugin/uni_modules.html#uni-modules) 规范,已经上架到 uni-app 的插件市场。
`uni-app插件市场`选择使用`HBuildX`导入或者选择手动在src目录下创建uni_modules文件夹并将`Wot Design Uni`解压到uni_modules中结构如下:
```
- uni_modules
- - - wot-design-uni
```
下载地址:<a href="https://ext.dcloud.net.cn/plugin?id=13889"><span >wot-design-uni</span></a>
## 配置
### 导入组件
::: tip 提醒
使用 `uni_modules` 安装时`Wot Design Uni`的组件天然支持`easycom`规范,无需额外配置就可以自动引入组件,而使用 `npm安装 `需按照此步骤配置,以下两种方案二选一即可。
:::
#### 配置easycom自动引入组件<el-tag type="primary" style="vertical-align: middle;margin-left:8px;" effect="dark" >方案1</el-tag>
传统vue组件需要安装、引用、注册三个步骤后才能使用组件。`easycom`将其精简为一步。 传统vue组件需要安装、引用、注册三个步骤后才能使用组件。`easycom`将其精简为一步。
只要组件路径符合规范(具体见[easycom](https://uniapp.dcloud.net.cn/collocation/pages.html#easycom)),就可以不用引用、注册,直接在页面中使用。 只要组件路径符合规范(具体见[easycom](https://uniapp.dcloud.net.cn/collocation/pages.html#easycom)),就可以不用引用、注册,直接在页面中使用。
@ -63,12 +74,12 @@ pnpm add wot-design-uni
} }
``` ```
### 基于vite配置自动引入组件<el-tag type="primary" style="vertical-align: middle;margin-left:8px;" effect="dark" >自动引入方案2</el-tag> #### 基于vite配置自动引入组件<el-tag type="primary" style="vertical-align: middle;margin-left:8px;" effect="dark" >方案2</el-tag>
如果不熟悉`easycom`,也可以通过[@uni-helper/vite-plugin-uni-components](https://github.com/uni-helper/vite-plugin-uni-components)实现组件的自动引入。 如果不熟悉`easycom`,也可以通过[@uni-helper/vite-plugin-uni-components](https://github.com/uni-helper/vite-plugin-uni-components)实现组件的自动引入。
:::tip 提醒 :::tip 提醒
- 推荐使用@uni-helper/vite-plugin-uni-components@0.0.9及以上版本因为在0.0.9版本开始其内置了`wot-design-uni``resolver` - 推荐使用@uni-helper/vite-plugin-uni-components@0.0.9及以上版本因为在0.0.9版本开始其内置了`wot-design-uni``resolver`
- 如果使用此方案时控制台打印很多`Sourcemap for points to missing source files`可以尝试将vite版本升级至4.5.x。 - 如果使用此方案时控制台打印很多`Sourcemap for points to missing source files`可以尝试将vite版本升级至`4.5.x`以上版本
::: :::
::: code-group ::: code-group
@ -85,37 +96,6 @@ pnpm add @uni-helper/vite-plugin-uni-components -D
``` ```
::: :::
***@uni-helper/vite-plugin-uni-components 0.0.8及之前版本***
```ts
// vite.config.ts
import { defineConfig } from "vite";
import uni from "@dcloudio/vite-plugin-uni";
import Components, { kebabCase } from '@uni-helper/vite-plugin-uni-components'
export default defineConfig({
plugins: [
// make sure put it before `Uni()`
Components({
resolvers: [
{
type: 'component',
resolve: (name: string) => {
if (name.match(/^Wd[A-Z]/)) {
const compName = kebabCase(name)
return {
name,
from: `wot-design-uni/components/${compName}/${compName}.vue`,
}
}
},
}
]
}), uni()],
});
```
***@uni-helper/vite-plugin-uni-components 0.0.9及以后版本***
```ts ```ts
// vite.config.ts // vite.config.ts
import { defineConfig } from "vite"; import { defineConfig } from "vite";
@ -133,7 +113,6 @@ export default defineConfig({
}), uni()], }), uni()],
}); });
``` ```
#### UI 组件类型提示
如果你使用 `pnpm` ,请在根目录下创建一个 `.npmrc` 文件,参见[issue](https://github.com/antfu/unplugin-vue-components/issues/389)。 如果你使用 `pnpm` ,请在根目录下创建一个 `.npmrc` 文件,参见[issue](https://github.com/antfu/unplugin-vue-components/issues/389)。
@ -145,7 +124,7 @@ public-hoist-pattern[]=@vue*
``` ```
## Volar 支持<el-tag type="primary" style="vertical-align: middle;margin-left:8px;" effect="dark" >推荐</el-tag> ## Volar 支持
如果您使用 `Volar`,请在 `tsconfig.json` 中通过 `compilerOptions.type` 指定全局组件类型。 如果您使用 `Volar`,请在 `tsconfig.json` 中通过 `compilerOptions.type` 指定全局组件类型。
:::tip :::tip
cli项目使用`uni_modules`安装无需配置,对`Volar`的支持自动生效,`HbuildX`项目不支持此配置,故此步骤仅在`cli`项目使用`npm`安装时需要配置。 cli项目使用`uni_modules`安装无需配置,对`Volar`的支持自动生效,`HbuildX`项目不支持此配置,故此步骤仅在`cli`项目使用`npm`安装时需要配置。
@ -166,7 +145,3 @@ cli项目使用`uni_modules`安装无需配置,对`Volar`的支持自动生效
``` html ``` html
<wd-toast></wd-toast> <wd-toast></wd-toast>
``` ```
:::tip 提示
使用uni_modules 安装时`Wot Design Uni`的组件天然支持`easycom`规范无需额外配置就可以自动引入组件而使用npm安装需要自行配置`easycom``@uni-helper/vite-plugin-uni-components`
:::