Skip to content

Latest commit

 

History

History
110 lines (80 loc) · 3.83 KB

README.md

File metadata and controls

110 lines (80 loc) · 3.83 KB

logo

Vant

Mobile UI Components built on Vue

npm version CI Status Coverage Status downloads Jsdelivr Hits Gzip Size

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


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 Vant 2 for Vue 2 project
npm i vant -S

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

Quickstart

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

const app = createApp();
app.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

Links

Preview

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

LICENSE

MIT