快速上手

介绍

通过本章节你可以了解到 Vant 的安装方法和基本使用姿势。

安装

通过 npm 安装

在现有项目中使用 Vant 时,可以通过 npm 进行安装:

  1. # Vue 3 项目,安装最新版 Vant
  2. npm i vant
  3. # Vue 2 项目,安装 Vant 2
  4. npm i vant@latest-v2

当然,你也可以通过 yarnpnpm 进行安装:

  1. # 通过 yarn 安装
  2. yarn add vant
  3. # 通过 pnpm 安装
  4. pnpm add vant

通过 CDN 安装

使用 Vant 最简单的方法是直接在 HTML 文件中引入 CDN 链接,之后你可以通过全局变量 vant 访问到所有组件。

  1. <!-- 引入样式文件 -->
  2. <link
  3. rel="stylesheet"
  4. href="https://fastly.jsdelivr.net/npm/vant@3/lib/index.css"
  5. />
  6. <!-- 引入 Vue 和 Vant 的 JS 文件 -->
  7. <script src="https://fastly.jsdelivr.net/npm/vue@3"></script>
  8. <script src="https://fastly.jsdelivr.net/npm/vant@3/lib/vant.min.js"></script>
  9. <script>
  10. // 在 #app 标签下渲染一个按钮组件
  11. const app = Vue.createApp({
  12. template: `<van-button>按钮</van-button>`,
  13. });
  14. app.use(vant);
  15. // 通过 CDN 引入时不会自动注册 Lazyload 组件
  16. // 可以通过下面的方式手动注册
  17. app.use(vant.Lazyload);
  18. // 调用函数组件,弹出一个 Toast
  19. vant.Toast('提示');
  20. app.mount('#app');
  21. </script>

免费 CDN

你可以通过以下免费 CDN 服务来使用 Vant:

注意:免费 CDN 一般用于制作原型或个人小型项目,不推荐在企业生产环境中使用免费 CDN。

对于企业开发者,建议使用以下方式:

  • 通过 npm 引入,并通过构建工具进行打包
  • 下载对应文件,并托管在你自己的服务器或 CDN 上

示例

示例工程

我们提供了丰富的示例工程,通过示例工程你可以了解如下内容:

  • 基于 Vite 和 Vant 搭建应用
  • 基于 Nuxt 和 Vant 搭建应用
  • 基于 Vue CLI 和 Vant 搭建应用
  • 配置按需引入组件
  • 配置基于 Rem 的适配方案
  • 配置基于 Viewport 的适配方案
  • 配置基于 TypeScript 的工程
  • 配置自定义主题色方案

引入组件

方法一. 常规用法

下面是使用 Vant 组件的用法示例:

  1. import { createApp } from 'vue';
  2. // 1. 引入你需要的组件
  3. import { Button } from 'vant';
  4. // 2. 引入组件样式
  5. import 'vant/lib/index.css';
  6. const app = createApp();
  7. // 3. 注册你需要的组件
  8. app.use(Button);

Vant 支持多种组件注册方式,除了在 app 上全局注册组件,你也可以选择其他的方式,比如局部注册,详见 组件注册 章节。

提示:Vant 默认支持 Tree Shaking,因此你不需要配置任何插件,通过 Tree Shaking 即可移除不需要的 JS 代码,但 CSS 样式无法通过这种方式优化,如果需要按需引入 CSS 样式,请参考下面的方法二。

方法二. 按需引入组件样式

在基于 vitewebpackvue-cli 的项目中使用 Vant 时,可以使用 unplugin-vue-components 插件,它可以自动引入组件,并按需引入组件的样式。

相比于常规用法,这种方式可以按需引入组件的 CSS 样式,从而减少一部分代码体积,但使用起来会变得繁琐一些。如果业务对 CSS 的体积要求不是特别极致,我们推荐使用更简便的常规用法。

1. 安装插件

  1. # 通过 npm 安装
  2. npm i unplugin-vue-components -D
  3. # 通过 yarn 安装
  4. yarn add unplugin-vue-components -D
  5. # 通过 pnpm 安装
  6. pnpm add unplugin-vue-components -D

2. 配置插件

如果是基于 vite 的项目,在 vite.config.js 文件中配置插件:

  1. import vue from '@vitejs/plugin-vue';
  2. import Components from 'unplugin-vue-components/vite';
  3. import { VantResolver } from 'unplugin-vue-components/resolvers';
  4. export default {
  5. plugins: [
  6. vue(),
  7. Components({
  8. resolvers: [VantResolver()],
  9. }),
  10. ],
  11. };

如果是基于 vue-cli 的项目,在 vue.config.js 文件中配置插件:

  1. const { VantResolver } = require('unplugin-vue-components/resolvers');
  2. const ComponentsPlugin = require('unplugin-vue-components/webpack');
  3. module.exports = {
  4. configureWebpack: {
  5. plugins: [
  6. ComponentsPlugin({
  7. resolvers: [VantResolver()],
  8. }),
  9. ],
  10. },
  11. };

如果是基于 webpack 的项目,在 webpack.config.js 文件中配置插件:

  1. const { VantResolver } = require('unplugin-vue-components/resolvers');
  2. const ComponentsPlugin = require('unplugin-vue-components/webpack');
  3. module.exports = {
  4. plugins: [
  5. ComponentsPlugin({
  6. resolvers: [VantResolver()],
  7. }),
  8. ],
  9. };

3. 使用组件

完成以上两步,就可以直接在模板中使用 Vant 组件了,unplugin-vue-components 会解析模板并自动注册对应的组件。

  1. <template>
  2. <van-button type="primary" />
  3. </template>

4. 引入函数组件的样式

Vant 中有个别组件是以函数的形式提供的,包括 ToastDialogNotifyImagePreview 组件。在使用函数组件时,unplugin-vue-components 无法自动引入对应的样式,因此需要手动引入样式。

  1. // Toast
  2. import { Toast } from 'vant';
  3. import 'vant/es/toast/style';
  4. // Dialog
  5. import { Dialog } from 'vant';
  6. import 'vant/es/dialog/style';
  7. // Notify
  8. import { Notify } from 'vant';
  9. import 'vant/es/notify/style';
  10. // ImagePreview
  11. import { ImagePreview } from 'vant';
  12. import 'vant/es/image-preview/style';

你可以在项目的入口文件或公共模块中引入以上组件的样式,这样在业务代码中使用组件时,便不再需要重复引入样式了。

提示:在单个项目中不应该同时使用「全量引入」和「按需引入」,否则会导致代码重复、样式错乱等问题。

在框架中使用

在 Nuxt 3 中使用

在 Nuxt 3 中使用 Vant 时,由于 Nuxt 3 框架本身的限制,需要在 nuxt.config.ts 中添加以下配置:

  1. import { defineNuxtConfig } from 'nuxt';
  2. export default defineNuxtConfig({
  3. experimental: {
  4. externalVue: true,
  5. },
  6. });

关于该问题的背景,可以参考以下 issue:

迁移提示

移除 babel-plugin-import

从 Vant 4.0 版本开始,将不再支持 babel-plugin-import,请移除项目中依赖的 babel-plugin-import 插件。

只需要删除 babel.config.js 中的以下代码即可:

  1. module.exports = {
  2. plugins: [
  3. - ['import', {
  4. - libraryName: 'vant',
  5. - libraryDirectory: 'es',
  6. - style: true
  7. - }, 'vant']
  8. ]
  9. };

收益

移除 babel-plugin-import 有以下收益:

  • 不再强依赖 babel,项目可以使用 esbuild、swc 等更高效的编译工具,大幅度提升编译效率。
  • 不再受到 babel-plugin-import 的 import 写法限制,可以从 vant 中导入除了组件以外的其他内容,比如 Vant 4 中新增的 showToast 等方法:
  1. import { showToast, showDialog } from 'vant';

快速上手 - 图1