vant/README.zh-CN.md

Vant

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

🔥 文档网站     🚀 小程序版

---

介绍

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

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

特性

• 🚀 性能极佳，组件平均体积小于 1KB（min+gzip）
• 🚀 65+ 个高质量组件，覆盖移动端主流场景
• 💪 使用 TypeScript 编写，提供完整的类型定义
• 💪 单元测试覆盖率超过 90%，提供稳定性保障
• 📖 提供完善的中英文文档和组件示例
• 📖 提供 Sketch 和 Axure 设计资源
• 🍭 支持 Vue 2、Vue 3 和微信小程序
• 🍭 支持主题定制，内置 700+ 个主题变量
• 🍭 支持按需引入和 Tree Shaking
• 🍭 支持服务器端渲染
• 🌍 支持国际化和语言包定制

安装

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

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

脚手架

推荐使用 Rsbuild 来创建一个脚手架项目。

Rsbuild 是基于 Rspack 的构建工具，由 Vant 作者开发，具备一流的构建速度和开发体验，对 Vant 提供第一优先级支持。

你可以通过以下命令创建一个 Rsbuild 项目：

npm create rsbuild@latest

请访问 Rsbuild 仓库 了解更多信息。

快速上手

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

Vue.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 在线主题预览工具
@antmjs/vantui	基于 Vant Weapp 开发的多端组件库，同时支持 Taro 和 React
@formily/vant	基于 Vant 和 Formily 开发的表单解决方案

链接

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

手机预览

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

微信讨论群

欢迎大家加入 Vant 交流群一起讨论，添加下方微信并注明『加入 Vant 交流群』即可

开源协议

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