blackteay/vant
1
0
Fork 0
mirror of https://gitee.com/vant-contrib/vant.git synced 2025-04-06 03:57:59 +08:00
Code Issues Projects Releases Wiki Activity

docs: add vite-plugin-style-import config guide (#8654)

Browse Source
This commit is contained in:
neverland 2021-05-03 16:44:43 +08:00 committed by GitHub
parent e4dfe8e4a8
commit a126f1c6e4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 89 additions and 67 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
docs/markdown/quickstart.en-US.md
View File

@ -80,10 +80,9 @@ Use [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) to
npm i babel-plugin-import -D npm i babel-plugin-import -D
``` ```
Set babel config in .babelrc or babel-loader: Set babel config in .babelrc or babel.config.js:
```json ```json
// Note: Don't set libraryDirectory if you are using webpack 1.
{ {
"plugins": [ "plugins": [
[ [
@ -98,45 +97,56 @@ Set babel config in .babelrc or babel-loader:
} }
``` ```
Then you can import components from vant:
```js ```js
// For users who use babel7, that can be configured in babel.config.js // Input
module.exports = { import { Button } from 'vant';
// Output
import Button from 'vant/es/button';
import 'vant/es/button/style';
```
> If you are using TypeScript，please use [ts-import-plugin](https://github.com/Brooooooklyn/ts-import-plugin) instead.
### 2. Vite Plugin
If you are using Vite, please use [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import).
```bash
npm i vite-plugin-style-import -D
```
```js
// vite.config.js
import vue from '@vitejs/plugin-vue';
import styleImport from 'vite-plugin-style-import';
export default {
plugins: [ plugins: [
[ vue(),
'import', styleImport({
{ libs: [
libraryName: 'vant', {
libraryDirectory: 'es', libraryName: 'vant',
style: true, esModule: true,
}, resolveStyle: (name) => `vant/es/${name}/style`,
'vant', },
], ],
}),
], ],
}; };
``` ```
Then you can import components from vant: ### 3. Manually import
```js ```js
import { Button } from 'vant'; import Button from 'vant/es/button';
import 'vant/es/button/style';
``` ```
#### Vite Plugin ### 4. Import all components
If you are using Vite, please use [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import) or [vite-plugin-imp](https://github.com/onebay/vite-plugin-imp) instead.
#### TypeScript Plugin
If you are using TypeScript，please use [ts-import-plugin](https://github.com/Brooooooklyn/ts-import-plugin) instead.
### 2. Manually import
```js
import Button from 'vant/lib/button';
import 'vant/lib/button/style';
```
### 3. Import all components
```js ```js
import { createApp } from 'vue'; import { createApp } from 'vue';

84
docs/markdown/quickstart.zh-CN.md
View File

@ -92,19 +92,18 @@ vue ui
## 引入组件 ## 引入组件
### 方式一. 自动按需引入组件 (推荐) ### 方式一. 通过 babel 插件按需引入组件
[babel-plugin-import](https://github.com/ant-design/babel-plugin-import) 是一款 babel 插件，它会在编译过程中将 import 的写法自动转换为按需引入的方式。 [babel-plugin-import](https://github.com/ant-design/babel-plugin-import) 是一款 babel 插件，它会在编译过程中将 import 语句自动转换为按需引入的方式。
```bash ```bash
# 安装插件 # 安装插件
npm i babel-plugin-import -D npm i babel-plugin-import -D
``` ```
在.babelrc 中添加配置： 在.babelrc 或 babel.config.js 中添加配置：
```json ```json
// 注意：webpack 1 无需设置 libraryDirectory
{ {
"plugins": [ "plugins": [
[ [
@ -119,48 +118,61 @@ npm i babel-plugin-import -D
} }
``` ```
接着你可以在代码中直接引入 Vant 组件，插件会自动将代码转化为按需引入的形式。
```js ```js
// 对于使用 babel7 的用户，可以在 babel.config.js 中配置 // 原始代码
module.exports = { import { Button } from 'vant';
// 编译后代码
import Button from 'vant/es/button';
import 'vant/es/button/style';
```
> 如果你在使用 TypeScript，可以使用 [ts-import-plugin](https://github.com/Brooooooklyn/ts-import-plugin) 实现按需引入。
### 方式二. 在 Vite 项目中按需引入组件
对于 vite 项目，可以使用 [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import) 实现按需引入, 原理和 `babel-plugin-import` 类似。
```bash
# 安装插件
npm i vite-plugin-style-import -D
```
```js
// vite.config.js
import vue from '@vitejs/plugin-vue';
import styleImport from 'vite-plugin-style-import';
export default {
plugins: [ plugins: [
[ vue(),
'import', styleImport({
{ libs: [
libraryName: 'vant', {
libraryDirectory: 'es', libraryName: 'vant',
style: true, esModule: true,
}, resolveStyle: (name) => `vant/es/${name}/style`,
'vant', },
], ],
}),
], ],
}; };
``` ```
接着你可以在代码中直接引入 Vant 组件： ### 方式三. 手动按需引入组件
在不使用插件的情况下，可以手动引入需要使用的组件和样式。
```js ```js
// 插件会自动将代码转化为方式二中的按需引入形式 // 引入组件
import { Button } from 'vant'; import Button from 'vant/es/button';
// 引入组件对应的样式，若组件没有样式文件，则无须引入
import 'vant/es/button/style';
``` ```
#### Vite 插件 ### 方式四. 导入所有组件
对于 vite 项目，可以使用 [vite-plugin-style-import](https://github.com/anncwb/vite-plugin-style-import) 或 [vite-plugin-imp](https://github.com/onebay/vite-plugin-imp) 实现按需引入。
#### TypeScript 插件
如果你在使用 TypeScript，可以使用 [ts-import-plugin](https://github.com/Brooooooklyn/ts-import-plugin) 实现按需引入。
### 方式二. 手动按需引入组件
在不使用插件的情况下，可以手动引入需要的组件。
```js
import Button from 'vant/lib/button';
import 'vant/lib/button/style';
```
### 方式三. 导入所有组件
Vant 支持一次性导入所有组件，引入所有组件会增加代码包体积，因此不推荐这种做法。 Vant 支持一次性导入所有组件，引入所有组件会增加代码包体积，因此不推荐这种做法。