README.zh-CN.md

Vant

轻量、可定制的移动端 Vue 组件库

🔥 文档网站（国内）   🌈 文档网站（GitHub）

---

介绍

Vant 是一个轻量、可定制的移动端组件库，于 2017 年开源。

目前 Vant 官方提供了 Vue 2 版本、Vue 3 版本和微信小程序版本，并由社区团队维护 React 版本和支付宝小程序版本。

特性

• 🚀 性能极佳，组件平均体积小于 1KB（min+gzip）
• 🚀 70+ 个高质量组件，覆盖移动端主流场景
• 🚀 零外部依赖，不依赖三方 npm 包
• 💪 使用 TypeScript 编写，提供完整的类型定义
• 💪 单元测试覆盖率超过 90%，提供稳定性保障
• 📖 提供丰富的中英文文档和组件示例
• 📖 提供 Sketch 和 Axure 设计资源
• 🍭 支持 Vue 2、Vue 3 和微信小程序
• 🍭 支持 Nuxt 2、Nuxt 3，提供 Nuxt 的 Vant Module
• 🍭 支持主题定制，内置 700+ 个主题变量
• 🍭 支持按需引入和 Tree Shaking
• 🍭 支持无障碍访问（持续改进中）
• 🍭 支持深色模式
• 🍭 支持服务器端渲染
• 🌍 支持国际化，内置 30+ 种语言包

安装

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

# Vue 3 项目，安装最新版 Vant
npm i vant

# Vue 2 项目，安装 Vant 2
npm i vant@latest-v2

当然，你也可以通过 yarn 或 pnpm 进行安装：

# 通过 yarn 安装
yarn add vant

# 通过 pnpm 安装
pnpm add vant

快速上手

import { createApp } from 'vue';
// 1. 引入你需要的组件
import { Button } from 'vant';
// 2. 引入组件样式
import 'vant/lib/index.css';

const app = createApp();

// 3. 注册你需要的组件
app.use(Button);

vant 也支持按需引入、CDN 引入等方式，详细说明见 快速上手.

浏览器支持

Vant 2 支持现代浏览器以及 Android >= 4.0、iOS >= 8.0。

Vant 3/4 支持现代浏览器以及 Chrome >= 51、iOS >= 10.0（与 Vue 3 一致）。

官方生态

由 Vant 官方团队维护的项目如下：

项目	描述
vant-weapp	Vant 微信小程序版
vant-demo	Vant 官方示例合集
vant-cli	开箱即用的组件库搭建工具
vant-icons	Vant 图标库
vant-touch-emulator	在桌面端使用 Vant 的辅助库
vant-nuxt	为 Nuxt 准备的模块

社区生态

由社区维护的项目如下，欢迎补充：

项目	描述
3lang3/react-vant	参照 Vant 打造的 React 框架移动端组件库
vant-aliapp	Vant 支付宝小程序版
taroify	Vant Taro 版
vant-theme	Vant 在线主题预览工具
@antmjs/vantui	基于 Vant Weapp 开发的多端组件库，同时支持 Taro 和 React
sfc-playground-vant	Vant Playground. 当前仅支持 Vant 3.0 以上

链接

• 详细文档
• 更新日志
• 码云镜像仓库
• Discussions 讨论区

手机预览

可以手机扫码以下二维码访问手机端 demo：

核心团队

以下是 Vant 和 Vant Weapp 的核心贡献者们：

chenjiahan	cookfront	wangnaiyi	pangxie	rex-zsd

nemo-shen	Lindysen	JakeLaoyu	landluck	wjw-gavin

贡献者们

感谢以下小伙伴们为 Vant 发展做出的贡献：

贡献指南

修改代码请阅读我们的 贡献指南。

使用过程中发现任何问题都可以提 Issue 给我们，当然，我们也非常欢迎你给我们发 PR。

在 Cloud IDE 中预览

https://idegithub.com/youzan/vant

开源协议

本项目基于 MIT 协议，请自由地享受和参与开源。