A lightweight, customizable Vue UI library for mobile web apps.
Documentation · Documentation (backup) · 中文介绍
--- ## Features - 🚀 1KB Component average size (min+gzip) - 🚀 80+ 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 Nuxt 2 & Nuxt 3, provide [Vant Module](https://github.com/vant-ui/vant-nuxt) for Nuxt - 🍭 Support Tree Shaking - 🍭 Support Custom Theme - 🍭 Support Accessibility (still improving) - 🍭 Support Dark Mode - 🍭 Support SSR - 🌍 Support i18n, built-in 30+ languages ## Install Using `npm` to install: ```bash # install latest Vant for Vue 3 project npm i vant # install Vant 2 for Vue 2 project npm i vant@latest-v2 ``` Using `yarn`, `pnpm`, or `bun`: ```bash # with yarn yarn add vant # with pnpm pnpm add vant # with Bun bun add vant ``` ## Scaffold It is recommended to use [Rsbuild](https://github.com/web-infra-dev/rsbuild) to create a scaffold project. Rsbuild is a build tool based on Rspack, developed by the author of Vant, with first-class build speed and development experience, providing first-priority support for Vant. You can create a Rsbuild project with the following command: ```bash npm create rsbuild@latest ``` Please visit the [Rsbuild repository](https://github.com/web-infra-dev/rsbuild) for more information. ## 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](https://vant-ui.github.io/vant/#/en-US/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) | WeChat MiniProgram UI | | [vant-demo](https://github.com/vant-ui/vant-demo) | Collection of Vant demos | | [vant-cli](https://github.com/vant-ui/vant/tree/main/packages/vant-cli) | Scaffold for UI library | | [vant-icons](https://github.com/vant-ui/vant/tree/main/packages/vant-icons) | Vant icons | | [vant-touch-emulator](https://github.com/vant-ui/vant/tree/main/packages/vant-touch-emulator) | Using vant in desktop browsers | | [vant-nuxt](https://github.com/vant-ui/vant-nuxt) | Vant module for Nuxt | ## Community Ecosystem | Project | Description | | --- | --- | | [3lang3/react-vant](https://github.com/3lang3/react-vant) | React mobile UI Components based on Vant | | [vant-aliapp](https://github.com/ant-move/Vant-Aliapp) | Alipay MiniProgram UI | | [vant-theme](https://github.com/Aisen60/vant-theme) | Online theme preview built on Vant UI | | [@antmjs/vantui](https://github.com/antmjs/vantui) | Mobile UI Components based on Vant, supporting Taro and React | | [Taroify](https://github.com/mallfoundry/taroify) | Taroify is the Taro version of Vant | | [vant-playground](https://github.com/LadyChatterleyLover/vant-playground) | Vant Playground | | [sfc-playground-vant](https://github.com/zhixiaoqiang/sfc-playground-vant) | Vant Playground | | [vue3-h5-template](https://github.com/yulimchen/vue3-h5-template) | Mobile project template based on Vant | | [vue3-vant-mobile](https://github.com/easy-temps/vue3-vant-mobile) | Mobile project template based on Vant | | [vscode-common-intellisense](https://github.com/Simon-He95/vscode-common-intellisense) | A VS Code extension that provides better intellisense to Vant developers | ## Links - [Documentation](https://vant-ui.github.io/vant/) - [Documentation (backup)](https://vant.pro/vant/) - [Changelog](https://vant-ui.github.io/vant/#/en-US/changelog) - [Discussions](https://github.com/vant-ui/vant/discussions) ## Preview You can scan the following QR code to access the demo：
## Core Team
Core contributors of Vant and Vant Weapp:
| [](https://github.com/chenjiahan/) | [](https://github.com/cookfront/) | [](https://github.com/w91/) | [](https://github.com/pangxie1991/) | [](https://github.com/rex-zsd/) | [](https://github.com/nemo-shen/) |
| :-: | :-: | :-: | :-: | :-: | :-: |
| [chenjiahan](https://github.com/chenjiahan/) | [cookfront](https://github.com/cookfront/) | [wangnaiyi](https://github.com/w91/) | [pangxie](https://github.com/pangxie1991/) | [rex-zsd](https://github.com/rex-zsd/) | [nemo-shen](https://github.com/nemo-shen/) |
| [](https://github.com/Lindysen/) | [](https://github.com/JakeLaoyu/) | [](https://github.com/landluck/) | [](https://github.com/wjw-gavin/) | [](https://github.com/inottn/) | [](https://github.com/zhousg/) |
| :-: | :-: | :-: | :-: | :-: | :-: |
| [Lindysen](https://github.com/Lindysen/) | [JakeLaoyu](https://github.com/JakeLaoyu/) | [landluck](https://github.com/landluck/) | [wjw-gavin](https://github.com/wjw-gavin/) | [inottn](https://github.com/inottn/) | [zhousg](https://github.com/zhousg/) |
## All Contributors
Thanks to the following friends for their contributions to Vant:
## Contribution Guide
Please make sure to read the [Contributing Guide](./.github/CONTRIBUTING.md) before making a pull request.
## Start On Web IDE
[https://github.dev/youzan/vant](https://github.dev/youzan/vant)
## LICENSE
Vant is [MIT](https://github.com/youzan/vant/blob/main/LICENSE) licensed.