README.zh-CN.md

Vant

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

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

---

介绍

Vant 是有赞前端团队开源的移动端组件库，于 2017 年开源，已持续维护 4 年时间。Vant 对内承载了有赞所有核心业务，对外服务十多万开发者，是业界主流的移动端组件库之一。

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

特性

• 提供 60 多个高质量组件，覆盖移动端各类场景
• 性能极佳，组件平均体积不到 1kb（min+gzip）
• 单元测试覆盖率 90%+，提供稳定性保障
• 完善的中英文文档和示例
• 支持 Vue 2 & Vue 3
• 支持按需引入
• 支持主题定制
• 支持国际化
• 支持 TypeScript
• 支持 SSR

安装

# Vue 2 项目，安装 Vant 2：
npm i vant -S

# Vue 3 项目，安装 Vant 3：
npm i vant@next -S

快速上手

import { createApp } from 'vue';
import { Button } from 'vant';
import 'vant/lib/index.css';

const app = createApp();
app.use(Button);

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

贡献代码

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

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

浏览器支持

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

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

官方生态

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

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

社区生态

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

项目	描述
3lang3/react-vant	参照 Vant 打造的 React 框架移动端组件库
mxdi9i7/vant-react	基于 React 和 TS 构建的移动端组件库
vant-aliapp	Vant 支付宝小程序版
taroify	Vant Taro 版
vant-theme	Vant 在线主题预览工具

链接

• 详细文档
• 更新日志
• Gitter 讨论组

手机预览

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

开源协议

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