Files
vant/packages/vant-auto-import-resolver/README.zh-CN.md
T

129 lines
2.3 KiB
Markdown

# Vant Auto Import Resolver
English | [简体中文](./README.zh-CN.md)
`@vant/auto-import-resolver` 是 [unplugin-vue-components](https://github.com/unplugin/unplugin-vue-components) 的一个解析器,用于实现 Vant 按需引入。
### 特性
- 支持 `Vite`, `Webpack`, `Rspack`, `Vue CLI`, `Rollup`, `esbuild`
- 支持自动引入组件对应的 CSS 样式
- 支持 SSR(服务端渲染)
### 安装
```shell
# via npm
npm i @vant/auto-import-resolver unplugin-vue-components -D
# via yarn
yarn add @vant/auto-import-resolver unplugin-vue-components -D
# via pnpm
pnpm add @vant/auto-import-resolver unplugin-vue-components -D
# via Bun
bun add @vant/auto-import-resolver unplugin-vue-components -D
```
## 使用
### Vite
```ts
// vite.config.ts
import Components from 'unplugin-vue-components/vite';
import { VantResolver } from '@vant/auto-import-resolver';
export default defineConfig({
plugins: [
Components({
resolvers: [VantResolver()],
}),
],
});
```
### Rollup
```ts
// rollup.config.js
import Components from 'unplugin-vue-components/rollup';
import { VantResolver } from '@vant/auto-import-resolver';
export default {
plugins: [
Components({
resolvers: [VantResolver()],
}),
],
};
```
### Webpack
```ts
// webpack.config.js
import Components from 'unplugin-vue-components/webpack';
import { VantResolver } from '@vant/auto-import-resolver';
module.exports = {
plugins: [
Components({
resolvers: [VantResolver()],
}),
],
};
```
### Rspack
```ts
// rspack.config.js
import Components from 'unplugin-vue-components/rspack';
import { VantResolver } from '@vant/auto-import-resolver';
module.exports = {
plugins: [
Components({
resolvers: [VantResolver()],
}),
],
};
```
### Vue CLI
```ts
// vue.config.js
import Components from 'unplugin-vue-components/webpack';
import { VantResolver } from '@vant/auto-import-resolver';
module.exports = {
configureWebpack: {
plugins: [
Components({
resolvers: [VantResolver()],
}),
],
},
};
```
### esbuild
```ts
// esbuild.config.js
import { build } from 'esbuild';
import Components from 'unplugin-vue-components/esbuild';
import { VantResolver } from '@vant/auto-import-resolver';
build({
plugins: [
Components({
resolvers: [VantResolver()],
}),
],
});
```