探客时代
Vant
Lightweight Mobile UI Components built on Vue
README
Vant
Lightweight Mobile UI Components built on Vue
🔥 文档网站（国内）
Features
- 🚀 1KB Component average size (min+gzip)
- 🚀 70+ High quality components
- 🚀 Zero third-party dependencies
- 💪 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 Accessibility (still improving)
- 🍭 Support Dark Mode
- 🍭 Support Nuxt 3
- 🍭 Support SSR
- 🌍 Support i18n, built-in 20+ languages
Install
Using npm to install:
- ``` sh
- # install latest Vant for Vue 3 project
- npm i vant
- # install Vant 2 for Vue 2 project
- npm i vant@latest-v2
- ```
Using yarn or pnpm:
- ``` sh
- # with yarn
- yarn add vant
- # with pnpm
- pnpm add vant
- ```
Quickstart
- ``` js
- import { createApp } from 'vue';
- // 1. Import the components you need
- import { Button } from 'vant';
- // 2. Import the components style
- import 'vant/lib/index.css';
- const app = createApp();
- // 3. Register the components you need
- app.use(Button);
- ```
See more in Quickstart.
Browser Support
Vant 2 supports modern browsers and Android >= 4.0、iOS >= 8.0.
Vant 3/4 supports modern browsers and Chrome >= 51、iOS >= 10.0 (same as Vue 3).
Official Ecosystem
| Project | Description |
|---|---|
| --- | --- |
| [vant-weapp](https://github.com/vant-ui/vant-weapp) | |
| [vant-demo](https://github.com/vant-ui/vant-demo) | Collection |
| [vant-cli](https://github.com/vant-ui/vant/tree/main/packages/vant-cli) | Scaffold |
| [vant-icons](https://github.com/vant-ui/vant/tree/main/packages/vant-icons) | Vant |
| [vant-touch-emulator](https://github.com/vant-ui/vant/tree/main/packages/vant-touch-emulator) | Using |
Community Ecosystem
| Project | Description |
|---|---|
| --- | --- |
| [3lang3/react-vant](https://github.com/3lang3/react-vant) | React |
| [vant-aliapp](https://github.com/ant-move/Vant-Aliapp) | Alipay |
| [taroify](https://gitee.com/mallfoundry/taroify) | Vant |
| [vant-theme](https://github.com/Aisen60/vant-theme) | Online |
| [@antmjs/vantui](https://github.com/antmjs/vantui) | Mobile |
| [sfc-playground-vant](https://github.com/zhixiaoqiang/sfc-playground-vant) | Try |
Links
Preview
You can scan the following QR code to access the demo：
Core Team
Core contributors of Vant and Vant Weapp:
| 
| 
| 
| 
| 
| 
| 
| 
|
| | | | | | | || :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
All Contributors
Thanks to the following friends for their contributions to Vant:
Contribution Guide
Please make sure to read the Contributing Guide before making a pull request.
