- 示例工程

快速上手

通过 npm 安装

在现有项目中使用 Vant 时，可以通过或 yarn 进行安装：

通过 CDN 安装

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

<!-- 引入样式文件 -->
<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/vant@next/lib/index.css"
/>
<!-- 引入 Vue 和 Vant 的 JS 文件 -->
<script src="https://cdn.jsdelivr.net/npm/vue@next"></script>
<script src="https://cdn.jsdelivr.net/npm/vant@next/lib/vant.min.js"></script>
<script>
  // 在 #app 标签下渲染一个按钮组件
  const app = Vue.createApp({
    template: `<van-button>按钮</van-button>`,
  });
  app.use(vant);
  // 通过 CDN 引入时不会自动注册 Lazyload 组件
  // 可以通过下面的方式手动注册
  // 调用函数组件，弹出一个 Toast
  vant.Toast('提示');
</script>

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

cdnjs

在新项目中使用 Vant 时，推荐使用 Vue 官方提供的脚手架 Vue Cli 创建项目并安装 Vant。

# 安装 Vue Cli
npm install -g @vue/cli
# 创建一个项目
vue create hello-world
# 创建完成后，可以通过命令打开图形化界面，如下图所示
vue ui

在图形化界面中，点击 依赖 -> 安装依赖，然后将 vant 添加到依赖中即可。

示例工程

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

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

方式一. 通过 babel 插件按需引入组件

babel-plugin-import 是一款 babel 插件，它会在编译过程中将 import 语句自动转换为按需引入的方式。

在.babelrc 或 babel.config.js 中添加配置：

{
  "plugins": [
    [
      "import",
      {
        "libraryName": "vant",
        "libraryDirectory": "es",
      }
    ]
  ]
}

// 原始代码
import { Button } from 'vant';
// 编译后代码
import Button from 'vant/es/button';
import 'vant/es/button/style';

对于 vite 项目，可以使用实现按需引入, 原理和 babel-plugin-import 类似。

// vite.config.js
import vue from '@vitejs/plugin-vue';
import styleImport from 'vite-plugin-style-import';
export default {
  plugins: [
    vue(),
    styleImport({
      libs: [
        {
          libraryName: 'vant',
          esModule: true,
          resolveStyle: (name) => `vant/es/${name}/style`,
        },
      ],
    }),
  ],
};

方式三. 手动按需引入组件

在不使用插件的情况下，可以手动引入需要使用的组件和样式。

// 引入组件
import Button from 'vant/es/button';
// 引入组件对应的样式，若组件没有样式文件，则无须引入

方式四. 导入所有组件

Vant 支持一次性导入所有组件，引入所有组件会增加代码包体积，因此不推荐这种做法。