Back to Vant

Home.En US

packages/vant/docs/markdown/home.en-US.md

4.10.06.7 KB
Original Source
<div class="van-doc-card"> <div class="van-doc-intro">
<h2 style="margin: 0; font-size: 36px; line-height: 60px;">Vant</h2>
<p>A lightweight, customizable Vue UI library for mobile web apps.</p>
</div> </div>

Features

  • πŸš€ 1KB Component average size (min+gzip)
  • πŸš€ 80+ 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 Nuxt 2 & Nuxt 3, provide Vant Module for Nuxt
  • 🍭 Support Tree Shaking
  • 🍭 Support Custom Theme
  • 🍭 Support Accessibility (still improving)
  • 🍭 Support Dark Mode
  • 🍭 Support SSR
  • 🌍 Support i18n, built-in 30+ languages

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:

bash
npm create rsbuild@latest

Please visit the Rsbuild repository for more information.

Quickstart

See 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).

Maintenance Status

The current maintenance status of each version of Vant is as follows:

NameFrameworkReleaseLatest VersionStatus
Vant 4Vue 32022.12Long-term support
Vant 3Vue 32020.12End of life
Vant 2Vue 22019.06End of life
Vant 1Vue 22018.03End of life

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
vant-nuxtVant module for Nuxt

Community Ecosystem

ProjectDescription
3lang3/react-vantReact mobile UI Components based on Vant
vant-themeOnline theme preview built on Vant UI
@antmjs/vantuiMobile UI Components based on Vant, supporting Taro and React
vant-playgroundVant Playground
sfc-playground-vantVant Playground
vue3-h5-templateMobile project template based on Vant
vue3-vant-mobileMobile project template based on Vant, out of the box
raycast-vant-documentationAn Raycast extension, it can search Vant UI library documentation in Raycast
nuxt-vant-mobileNuxt ⁴ project template based on Vant, out of the box
mobvueA well-crafted mobile web app template

Contribution

Core Team

Core contributors of Vant and Vant Weapp:

chenjiahancookfrontwangnaiyipangxierex-zsdnemo-shen
LindysenJakeLaoyulandluckwjw-gavininottnzhousg

All Contributors

Thanks to the following friends for their contributions to Vant:

<a href="https://github.com/vant-ui/vant/graphs/contributors" target="_blank"> </a>

Contribution Guide

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

LICENSE

MIT.