Skip to content
/ vant Public
forked from youzan/vant

A lightweight, customizable Vue UI library for mobile web apps.

License

Notifications You must be signed in to change notification settings

ly525/vant

 
 

Repository files navigation

logo

Vant

Mobile UI Components built on Vue

npm version npm version Coverage Status downloads Jsdelivr Hits Gzip Size

🔥 文档网站     🇨🇳 中文版介绍     🚀 小程序版


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

# Install Vant 2 for Vue 2 project
npm i vant@latest-v2 -S

Scaffold

It is recommended to use 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:

npm create rsbuild@latest

Please visit the Rsbuild repository for more information.

Quickstart

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

Vue.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
@formily/vant Form solution based on Vant and Formily

Links

Preview

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

LICENSE

MIT

About

A lightweight, customizable Vue UI library for mobile web apps.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 51.8%
  • Less 17.7%
  • Vue 16.4%
  • TypeScript 13.8%
  • HTML 0.2%
  • Smarty 0.1%