README.md

    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';
    import { Button } from 'vant';
    import 'vant/lib/index.css';
    
    const app = 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

    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
    rc-ui-lib 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

    项目简介

    Lightweight Mobile UI Components built on Vue

    🚀 Github 镜像仓库 🚀

    源项目地址

    https://github.com/youzan/vant

    发行版本 179

    v3.5.4

    全部发行版

    贡献者 107

    全部贡献者

    开发语言

    • TypeScript 61.7 %
    • Vue 15.9 %
    • Less 14.0 %
    • JavaScript 8.0 %
    • HTML 0.1 %