Skip to content

Repository files navigation

logo

Vant

Mobile UI Components built on Vue

npm versionCI StatusCoverage StatusdownloadsJsdelivr HitsGzip Size

🔥 文档网站(国内) 🌈 文档网站(GitHub) 🇨🇳 中文版介绍


Features

  • 🚀 1KB Component average size (min+gzip)
  • 🚀 70+ 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 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';import{Button}from'vant';import'vant/lib/index.css';constapp=createApp();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

ProjectDescription
vant-weappWeChat MiniProgram UI
vant-demoCollection of Vant demos
vant-cliScaffold for UI library
vant-iconsVant icons
vant-touch-emulatorUsing vant in desktop browsers

Community Ecosystem

ProjectDescription
3lang3/react-vantReact mobile UI Components based on Vant
rc-ui-libReact mobile UI Components based on Vant
vant-aliappAlipay MiniProgram UI
taroifyVant Taro
vant-themeOnline theme preview built on Vant UI
@antmjs/vantuiMobile UI Components based on Vant, supporting Taro and React
sfc-playground-vantTry 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:

chenjiahancookfrontw91pangxie1991rex-zsdnemo-shenLindysennemo-shen
chenjiahancookfrontwangnaiyipangxierex-zsdnemo-shenLindysenJakeLaoyu

All Contributors

Thanks to the following friends for their contributions to Vant:

contributors

Contribution Guide

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

LICENSE

MIT

About

Lightweight Mobile UI Components built on Vue

Resources

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages