Skip to content

Commit

Permalink
docs: remove VantImports example (#12894)
Browse files Browse the repository at this point in the history
  • Loading branch information
chenjiahan authored May 28, 2024
1 parent 0adc41a commit 6cef6b8
Show file tree
Hide file tree
Showing 4 changed files with 24 additions and 44 deletions.
18 changes: 6 additions & 12 deletions packages/vant-auto-import-resolver/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,11 @@ bun add @vant/auto-import-resolver unplugin-vue-components unplugin-auto-import
// vite.config.ts
import AutoImport from 'unplugin-auto-import/vite';
import Components from 'unplugin-vue-components/vite';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

export default defineConfig({
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -55,12 +54,11 @@ export default defineConfig({
// rollup.config.js
import AutoImport from 'unplugin-auto-import/rollup';
import Components from 'unplugin-vue-components/rollup';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

export default {
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -76,12 +74,11 @@ export default {
// webpack.config.js
import AutoImport from 'unplugin-auto-import/webpack';
import Components from 'unplugin-vue-components/webpack';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

module.exports = {
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -97,12 +94,11 @@ module.exports = {
// rspack.config.js
import AutoImport from 'unplugin-auto-import/rspack';
import Components from 'unplugin-vue-components/rspack';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

module.exports = {
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -118,13 +114,12 @@ module.exports = {
// vue.config.js
import AutoImport from 'unplugin-auto-import/webpack';
import Components from 'unplugin-vue-components/webpack';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

module.exports = {
configureWebpack: {
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -142,12 +137,11 @@ module.exports = {
import { build } from 'esbuild';
import AutoImport from 'unplugin-auto-import/esbuild';
import Components from 'unplugin-vue-components/esbuild';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

build({
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand Down
18 changes: 6 additions & 12 deletions packages/vant-auto-import-resolver/README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,11 @@ bun add @vant/auto-import-resolver unplugin-vue-components unplugin-auto-import
// vite.config.ts
import AutoImport from 'unplugin-auto-import/vite';
import Components from 'unplugin-vue-components/vite';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

export default defineConfig({
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -55,12 +54,11 @@ export default defineConfig({
// rollup.config.js
import AutoImport from 'unplugin-auto-import/rollup';
import Components from 'unplugin-vue-components/rollup';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

export default {
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -76,12 +74,11 @@ export default {
// webpack.config.js
import AutoImport from 'unplugin-auto-import/webpack';
import Components from 'unplugin-vue-components/webpack';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

module.exports = {
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -97,12 +94,11 @@ module.exports = {
// rspack.config.js
import AutoImport from 'unplugin-auto-import/rspack';
import Components from 'unplugin-vue-components/rspack';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

module.exports = {
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -118,13 +114,12 @@ module.exports = {
// vue.config.js
import AutoImport from 'unplugin-auto-import/webpack';
import Components from 'unplugin-vue-components/webpack';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

module.exports = {
configureWebpack: {
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -142,12 +137,11 @@ module.exports = {
import { build } from 'esbuild';
import AutoImport from 'unplugin-auto-import/esbuild';
import Components from 'unplugin-vue-components/esbuild';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

build({
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand Down
16 changes: 6 additions & 10 deletions packages/vant/docs/markdown/quickstart.en-US.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,15 +152,14 @@ import { defineConfig } from '@rsbuild/core';
import { pluginVue } from '@rsbuild/plugin-vue';
import AutoImport from 'unplugin-auto-import/rspack';
import Components from 'unplugin-vue-components/rspack';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

export default defineConfig({
plugins: [pluginVue()],
tools: {
rspack: {
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -178,13 +177,12 @@ For Vite based project,configure the plugin in the `vite.config.js` file:
import vue from '@vitejs/plugin-vue';
import AutoImport from 'unplugin-auto-import/vite';
import Components from 'unplugin-vue-components/vite';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

export default {
plugins: [
vue(),
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -197,19 +195,18 @@ export default {
For vue-cli based project,configure the plugin in the `vue.config.js` file:

```js
const { VantResolver, VantImports } = require('@vant/auto-import-resolver');
const { VantResolver } = require('@vant/auto-import-resolver');
const AutoImport = require('unplugin-auto-import/webpack');
const Components = require('unplugin-vue-components/webpack');

module.exports = {
configureWebpack: {
plugins: [
// When the version of unplugin-vue-components is less than 0.26.0:
AutoImport({ imports: [VantImports()], resolvers: [VantResolver()] }),
AutoImport({ resolvers: [VantResolver()] }),
Components({ resolvers: [VantResolver()] }),
// when the unplugin-vue-components version is greater than or equal to 0.26.0:
AutoImport.default({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components.default({ resolvers: [VantResolver()] }),
Expand All @@ -221,18 +218,17 @@ module.exports = {
For webpack based project,configure the plugin in the `webpack.config.js` file:

```js
const { VantResolver, VantImports } = require('@vant/auto-import-resolver');
const { VantResolver } = require('@vant/auto-import-resolver');
const AutoImport = require('unplugin-auto-import/webpack');
const Components = require('unplugin-vue-components/webpack');

module.exports = {
plugins: [
// When the version of unplugin-vue-components is less than 0.26.0:
AutoImport({ imports: [VantImports()], resolvers: [VantResolver()] }),
AutoImport({ resolvers: [VantResolver()] }),
Components({ resolvers: [VantResolver()] }),
// when the unplugin-vue-components version is greater than or equal to 0.26.0:
AutoImport.default({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components.default({ resolvers: [VantResolver()] }),
Expand Down
16 changes: 6 additions & 10 deletions packages/vant/docs/markdown/quickstart.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -174,15 +174,14 @@ import { defineConfig } from '@rsbuild/core';
import { pluginVue } from '@rsbuild/plugin-vue';
import AutoImport from 'unplugin-auto-import/rspack';
import Components from 'unplugin-vue-components/rspack';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

export default defineConfig({
plugins: [pluginVue()],
tools: {
rspack: {
plugins: [
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -200,13 +199,12 @@ export default defineConfig({
import vue from '@vitejs/plugin-vue';
import AutoImport from 'unplugin-auto-import/vite';
import Components from 'unplugin-vue-components/vite';
import { VantResolver, VantImports } from '@vant/auto-import-resolver';
import { VantResolver } from '@vant/auto-import-resolver';

export default {
plugins: [
vue(),
AutoImport({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components({
Expand All @@ -219,19 +217,18 @@ export default {
如果是基于 vue-cli 的项目,在 `vue.config.js` 文件中配置插件:

```js
const { VantResolver, VantImports } = require('@vant/auto-import-resolver');
const { VantResolver } = require('@vant/auto-import-resolver');
const AutoImport = require('unplugin-auto-import/webpack');
const Components = require('unplugin-vue-components/webpack');

module.exports = {
configureWebpack: {
plugins: [
// 当 unplugin-vue-components 版本小于 0.26.0 时,使用以下写法
AutoImport({ imports: [VantImports()], resolvers: [VantResolver()] }),
AutoImport({ resolvers: [VantResolver()] }),
Components({ resolvers: [VantResolver()] }),
//当 unplugin-vue-components 版本大于等于 0.26.0 时,使用以下写法
AutoImport.default({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components.default({ resolvers: [VantResolver()] }),
Expand All @@ -243,18 +240,17 @@ module.exports = {
如果是基于 webpack 的项目,在 `webpack.config.js` 文件中配置插件:

```js
const { VantResolver, VantImports } = require('@vant/auto-import-resolver');
const { VantResolver } = require('@vant/auto-import-resolver');
const AutoImport = require('unplugin-auto-import/webpack');
const Components = require('unplugin-vue-components/webpack');

module.exports = {
plugins: [
// 当 unplugin-vue-components 版本小于 0.26.0 时,使用以下写法
AutoImport({ imports: [VantImports()], resolvers: [VantResolver()] }),
AutoImport({ resolvers: [VantResolver()] }),
Components({ resolvers: [VantResolver()] }),
//当 unplugin-vue-components 版本大于等于 0.26.0 时,使用以下写法
AutoImport.default({
imports: [VantImports()],
resolvers: [VantResolver()],
}),
Components.default({ resolvers: [VantResolver()] }),
Expand Down

0 comments on commit 6cef6b8

Please sign in to comment.