快速上手

脚手架

推荐使用 Vue 官方提供的脚手架 Vue Cli 3 创建项目

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

快速上手  - 图1

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

示例工程

我们提供了一个基于 Vue Cli 3 的示例工程,仓库地址为 Vant Demo,示例工程会帮助你了解如下内容:

  • 基于 vant 搭建单页面应用,配置按需引入
  • 配置 rem 适配方案
  • 配置 viewport 适配方案
  • 配置 TypeScript 工程
  • 配置自定义主题色方案

安装

  1. # 通过 npm 安装
  2. npm i vant -S
  3. # 通过 yarn 安装
  4. yarn add vant

引入组件

方式一. 自动按需引入组件 (推荐)

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

  1. # 安装插件
  2. npm i babel-plugin-import-D
  1. // 在.babelrc 中添加配置
  2. // 注意:webpack 1 无需设置 libraryDirectory
  3. {
  4. "plugins":[
  5. ["import",{
  6. "libraryName":"vant",
  7. "libraryDirectory":"es",
  8. "style":true
  9. }]
  10. ]
  11. }
  12. // 对于使用 babel7 的用户,可以在 babel.config.js 中配置
  13. module.exports ={
  14. plugins:[
  15. ['import',{
  16. libraryName:'vant',
  17. libraryDirectory:'es',
  18. style:true
  19. },'vant']
  20. ]
  21. };
  1. // 接着你可以在代码中直接引入 Vant 组件
  2. // 插件会自动将代码转化为方式二中的按需引入形式
  3. import{Button}from'vant';

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

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

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

  1. importButtonfrom'vant/lib/button';
  2. import'vant/lib/button/style';

方式三. 导入所有组件

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

  1. importVuefrom'vue';
  2. importVantfrom'vant';
  3. import'vant/lib/index.css';
  4. Vue.use(Vant);

注意:配置 babel-plugin-import 插件后将不允许导入所有组件

方式四. 通过 CDN 引入

  1. <!-- 引入样式 -->
  2. <linkrel="stylesheet"href="https://cdn.jsdelivr.net/npm/vant@2.0/lib/index.css">
  3. <!-- 引入组件 -->
  4. <scriptsrc="https://cdn.jsdelivr.net/npm/vue/dist/vue.min.js"></script>
  5. <scriptsrc="https://cdn.jsdelivr.net/npm/vant@2.0/lib/vant.min.js"></script>
  6. <script>
  7. varVue= window.Vue;
  8. var vant = window.vant;
  9. // 注册组件
  10. Vue.use(vant);
  11. // 调用函数式组件
  12. vant.Toast('提示');
  13. </script>

其他

Rem 适配

Vant 中的样式默认使用px作为单位,如果需要使用rem单位,推荐使用以下两个工具

  • postcss-pxtorem 是一款 postcss 插件,用于将单位转化为 rem
  • lib-flexible 用于设置 rem 基准值下面提供了一份基本的 postcss 配置,可以在此配置的基础上根据项目需求进行修改
  1. module.exports ={
  2. plugins:{
  3. 'autoprefixer':{
  4. browsers:['Android >= 4.0','iOS >= 7']
  5. },
  6. 'postcss-pxtorem':{
  7. rootValue:37.5,
  8. propList:['*']
  9. }
  10. }
  11. }

注意:在配置 postcss-loader 时,应避免 ignore node_modules 目录,这会导致 Vant 的样式无法被编译

在桌面端使用

Vant 组件默认只适配了移动端设备,如果你需要在桌面端使用 vant,可以引入我们提供的 @vant/touch-emulator.

  1. # 安装模块
  2. npm i @vant/touch-emulator -S
  1. // 引入模块后自动生效
  2. import'@vant/touch-emulator';

快速上手  - 图2