快速上手

介绍

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

安装

通过 npm 安装

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

  1. # Vue 2 项目,安装 Vant 2:
  2. npm i vant -S
  3. # Vue 3 项目,安装 Vant 3:
  4. npm i vant@next -S

通过 CDN 安装

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

  1. <!-- 引入样式文件 -->
  2. <link
  3. rel="stylesheet"
  4. href="https://cdn.jsdelivr.net/npm/vant@next/lib/index.css"
  5. />
  6. <!-- 引入 Vue 和 Vant 的 JS 文件 -->
  7. <script src="https://cdn.jsdelivr.net/npm/vue@next"></script>
  8. <script src="https://cdn.jsdelivr.net/npm/vant@next/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 服务来使用 Vant:

通过脚手架安装

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

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

快速上手 - 图1

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

示例

示例工程

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

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

引入组件

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

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

  1. # 安装插件
  2. npm i babel-plugin-import -D

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

  1. {
  2. "plugins": [
  3. [
  4. "import",
  5. {
  6. "libraryName": "vant",
  7. "libraryDirectory": "es",
  8. "style": true
  9. }
  10. ]
  11. ]
  12. }

接着你可以在代码中直接引入 Vant 组件,插件会自动将代码转化为按需引入的形式。

  1. // 原始代码
  2. import { Button } from 'vant';
  3. // 编译后代码
  4. import Button from 'vant/es/button';
  5. import 'vant/es/button/style';

如果你在使用 TypeScript,可以使用 ts-import-plugin 实现按需引入。

方式二. 在 Vite 项目中按需引入组件

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

  1. # 安装插件
  2. npm i vite-plugin-style-import -D
  1. // vite.config.js
  2. import vue from '@vitejs/plugin-vue';
  3. import styleImport from 'vite-plugin-style-import';
  4. export default {
  5. plugins: [
  6. vue(),
  7. styleImport({
  8. libs: [
  9. {
  10. libraryName: 'vant',
  11. esModule: true,
  12. resolveStyle: (name) => `vant/es/${name}/style`,
  13. },
  14. ],
  15. }),
  16. ],
  17. };

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

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

  1. // 引入组件
  2. import Button from 'vant/es/button';
  3. // 引入组件对应的样式,若组件没有样式文件,则无须引入
  4. import 'vant/es/button/style';

方式四. 导入所有组件

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

  1. import { createApp } from 'vue';
  2. import Vant from 'vant';
  3. import 'vant/lib/index.css';
  4. const app = createApp();
  5. app.use(Vant);

Tips: 配置按需引入后,将不允许直接导入所有组件。

快速上手 - 图2