Skip to content

openwebf/vant-webf

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

logo

Vant

Lightweight Mobile UI Components built on Vue

npm version CI Status Coverage Status downloads Gzip Size

๐Ÿ”ฅ ๆ–‡ๆกฃ็ฝ‘็ซ™๏ผˆๅ›ฝๅ†…๏ผ‰ ย  ๐ŸŒˆ ๆ–‡ๆกฃ็ฝ‘็ซ™๏ผˆGitHub๏ผ‰ ย  ๐Ÿ‡จ๐Ÿ‡ณ ไธญๆ–‡็‰ˆไป‹็ป


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 w91 pangxie1991 rex-zsd nemo-shen Lindysen nemo-shen
chenjiahan cookfront wangnaiyi pangxie rex-zsd nemo-shen Lindysen JakeLaoyu

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