vant README

The project's README from github.com/youzan/vant. As one markdown file: README.md.

logo

Vant

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

npm version Coverage Status downloads

Documentation   ·   Documentation (backup)   ·   中文介绍   ·   日本語


Features

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, pnpm, or bun:

# with yarn
yarn add vant

# with pnpm
pnpm add vant

# with Bun
bun add vant

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 { 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
vant-nuxt Vant module for Nuxt

Community Ecosystem

Project Description
3lang3/react-vant React mobile UI Components based on Vant
vant-theme Online theme preview built on Vant UI
@antmjs/vantui Mobile UI Components based on Vant, supporting Taro and React
Taroify Taroify is the Taro version of Vant
vant-playground Vant Playground
sfc-playground-vant Vant Playground
vue3-h5-template Mobile project template based on Vant
vue3-vant-mobile Mobile project template based on Vant, out of the box
vscode-common-intellisense A VS Code extension that provides better intellisense to Vant developers
nuxt-vant-mobile Nuxt ⁴ project template based on Vant, out of the box
mobvue A well-crafted mobile web app template

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
chenjiahan cookfront wangnaiyi pangxie rex-zsd nemo-shen
Lindysen JakeLaoyu landluck wjw-gavin inottn zhousg
Lindysen JakeLaoyu landluck wjw-gavin inottn zhousg

Contribution Guide

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

Start On Web IDE

https://github.dev/youzan/vant

LICENSE

Vant is MIT licensed.

vant (youzan/vant)

Searching Database…

24.4K ·GitHub
Что это?Vant — это лёгкая настраиваемая библиотека UI-компонентов Vue для мобильных веб-приложений: более 80 качественных компонентов, каждый в среднем около 1 КБ (min+gzip). Её развивает Youzan, лицензия — MIT.
Это фреймворк для целого приложения или библиотека компонентов?Это библиотека компонентов: вы подключаете её к своему Vue-проекту и импортируете только нужные компоненты — благодаря Tree Shaking неиспользуемые не попадут в итоговую сборку.
Как добавить её в проект?Установите привычным пакетным менеджером — подойдут npm, yarn, pnpm и bun. Для нового проекта в README советуют использовать Rsbuild — инструмент сборки на основе Rspack от автора Vant, где Vant поддерживается в первую очередь.
Она работает с Vue 3 или только со старыми версиями Vue?И с той, и с другой: Vant поддерживает Vue 2 и Vue 3, а также Nuxt 2/3 через специальный модуль Vant. У самой библиотеки нет ни одной сторонней зависимости.
Будет ли она работать на старых телефонах и в десктопных браузерах?Vant 3/4 ориентирована на современные браузеры — Chrome >= 51 и iOS >= 10, та же база, что у Vue 3 (Vant 2 поддерживала вплоть до Android 4.0 и iOS 8). Компоненты рассчитаны в первую очередь на сенсорный ввод, поэтому на десктопе нужно добавить пакет vant-touch-emulator.
Где будут работать приложения на её основе?В браузере — в любом современном мобильном браузере, а на десктопе через эмулятор касаний; подключается через npm в веб-проекте.
Под какой лицензией она распространяется?MIT — свободная лицензия, можно спокойно использовать в коммерческих продуктах.
Что идёт из коробки, кроме самих компонентов?Кастомные темы и тёмный режим, поддержка SSR, доступность (a11y, пока в развитии) и i18n с более чем 30 встроенными языками. Есть также ресурсы для дизайна в Sketch и Axure — пригодятся, если вы рисуете макеты экранов до написания кода.
Насколько она утяжелит мою мобильную страницу?Компонент в среднем весит около 1 КБ в min+gzip — лёгкость здесь одна из главных особенностей библиотеки, а покрытие кода юнит-тестами превышает 90%.
Я использую React — есть ли здесь что-то для меня?Официальная библиотека только для Vue, но в экосистеме перечислены порты для React от сообщества: react-vant, @antmjs/vantui (с поддержкой Taro) и Taroify. Есть ещё vant-weapp — версия для WeChat MiniProgram.
Можно опробовать компоненты, прежде чем встраивать их в приложение?Да — в экосистеме есть Vant Playground для экспериментов прямо в браузере, в README дана ссылка на демо, которое можно открыть, отсканировав QR-код, а расширение для VS Code добавляет подсказки Vant прямо во время написания кода.
Creator
youzan
Size
122.3 MB
Stars
24.4K
Age
9y
Commits · 90 Days