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 (Requires upgrade to Vant 4)- π Support SSR
π Support i18n, built-in 20+ languages
Install
Using npm
to install:
# 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
:
# with yarn
yarn add vant
# with pnpm
pnpm add vant
Quickstart
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 | 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 |
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 |
sfc-playground-vant | Try Vant in the Playground. Currently only Vant 3+ is supported |
Links
Preview
You can scan the following QR code to access the demoοΌ
Core Team
Core contributors of Vant and Vant Weapp:
chenjiahan | cookfront | wangnaiyi | pangxie | rex-zsd | nemo-shen | Lindysen | JakeLaoyu |
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.