Features

• 🚀 1KB Component average size (min+gzip)
• 🚀 65+ High quality components
• 💪 90%+ Unit test coverage
• 💪 Written in TypeScript
• 📖 Extensive documentation and demos
• 📖 Provide Sketch and Axure design resources
• 🍭 Support Vue 2 & Vue 3
• 🍭 Support Tree Shaking
• 🍭 Support Custom Theme
• 🍭 Support i18n
• 🌍 Support SSR

Install

# Install latest Vant for Vue 3 project
npm i vant -S

# Install Vant 2 for Vue 2 project
npm i vant@latest-v2 -S

Quickstart

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

Vue.use(Button);

See more in Quickstart.

Contribution

Please make sure to read the Contributing Guide before making a pull request.

Browser Support

Vant 2 supports modern browsers and Android >= 4.0、iOS >= 8.0.

Vant 3 supports modern browsers and Chrome >= 51、iOS >= 10.0 (same as Vue 3).

Official Ecosystem

| Project | Description | | --- | --- | | vant-weapp | WeChat MiniProgram UI | | vant-demo | Collection of Vant demos | | vant-cli | Scaffold for UI library | | vant-icons | Vant icons | | vant-touch-emulator | Using vant in desktop browsers |

Community Ecosystem

| Project | Description | | --- | --- | | 3lang3/react-vant | React mobile UI Components based on Vant | | mxdi9i7/vant-react | Mobile UI Components built on React and TS, inspired by Vant | | vant-aliapp | Alipay MiniProgram UI | | taroify | Vant Taro | | vant-theme | Online theme preview built on Vant UI | | @antmjs/vantui | Mobile UI Components based on Vant, supporting Taro and React | | @formily/vant | Form solution based on Vant and Formily |

Links

• Documentation
• Changelog
• Gitter

Preview

You can scan the following QR code to access the demo：

LICENSE

MIT

Dev Install

# 在进行本地开发前，请先确保你的开发环境中安装了 Node.js >= 14.19.0。

# 依赖安装：
cd vant && yarn

# 运行
yarn dev

Catalogue

仓库的组件代码位于 src 下，每个组件一个文件夹 docs 目录下是文档网站的代码，本地开发时可以在目录下运行 yarn dev 开启文档网站项目主要目录如下：

vant ├─ build # 构建 ├─ docs # 文档 ├─ src # 组件 ├─ packages # 子包 ├─ test # 单测 └─ types # 类型

Add New Component

添加新组件时，请按照下面的目录结构组织文件，并在 vant.config.js 中配置组件名称。

src └─ button ├─ demo # 示例代码 ├─ test # 单元测试 ├─ index.js # 组件入口 ├─ index.less # 组件样式 ├─ README.md # 英文文档 └─ README.zh-CN.md # 中文文档