mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-05 05:42:44 +08:00
156 lines
7.0 KiB
Markdown
156 lines
7.0 KiB
Markdown
<p align="center">
|
||
<img alt="logo" src="https://fastly.jsdelivr.net/npm/@vant/assets/logo.png" width="120" style="margin-bottom: 10px;">
|
||
</p>
|
||
|
||
<h1 align="center">Vant</h1>
|
||
|
||
<p align="center">轻量、可靠的移动端 Vue 组件库</p>
|
||
|
||
<p align="center">
|
||
<img src="https://img.shields.io/npm/v/vant?style=flat-square" alt="npm version" />
|
||
<img src="https://img.shields.io/github/workflow/status/vant-ui/vant/CI/dev?style=flat-square" alt="CI Status" />
|
||
<img src="https://img.shields.io/codecov/c/github/vant-ui/vant/dev.svg?style=flat-square&color=#4fc08d" alt="Coverage Status" />
|
||
<img src="https://img.shields.io/npm/dm/vant.svg?style=flat-square&color=#4fc08d" alt="downloads" />
|
||
<img src="https://img.badgesize.io/https://unpkg.com/vant@3/lib/vant.min.js?compression=gzip&style=flat-square&label=gzip%20size&color=#4fc08d" alt="Gzip Size" />
|
||
</p>
|
||
|
||
<p align="center">
|
||
🔥 <a href="https://vant-contrib.gitee.io/vant">文档网站（国内）</a>
|
||
|
||
🌈 <a href="https://vant-ui.github.io/vant">文档网站（GitHub）</a>
|
||
</p>
|
||
|
||
---
|
||
|
||
### 介绍
|
||
|
||
Vant 是一个**轻量、可靠的移动端组件库**，于 2017 年开源。
|
||
|
||
目前 Vant 官方提供了 [Vue 2 版本](https://vant-contrib.gitee.io/vant/v2)、[Vue 3 版本](https://vant-contrib.gitee.io/vant)和[微信小程序版本](http://vant-contrib.gitee.io/vant-weapp)，并由社区团队维护 [React 版本](https://github.com/3lang3/react-vant)和[支付宝小程序版本](https://github.com/ant-move/Vant-Aliapp)。
|
||
|
||
## 特性
|
||
|
||
- 🚀 性能极佳，组件平均体积小于 1KB（min+gzip）
|
||
- 🚀 70+ 个高质量组件，覆盖移动端主流场景
|
||
- 🚀 零外部依赖，不依赖三方 npm 包
|
||
- 💪 使用 TypeScript 编写，提供完整的类型定义
|
||
- 💪 单元测试覆盖率超过 90%，提供稳定性保障
|
||
- 📖 提供丰富的中英文文档和组件示例
|
||
- 📖 提供 Sketch 和 Axure 设计资源
|
||
- 🍭 支持 Vue 2、Vue 3 和微信小程序
|
||
- 🍭 支持主题定制，内置 700+ 个主题变量
|
||
- 🍭 支持按需引入和 Tree Shaking
|
||
- 🍭 支持无障碍访问（持续改进中）
|
||
- 🍭 支持深色模式（从 [Vant 4](https://vant-contrib.gitee.io/vant/v4/#/zh-CN/config-provider) 开始支持）
|
||
- 🍭 支持服务器端渲染
|
||
- 🌍 支持国际化，内置 20+ 种语言包
|
||
|
||
## 安装
|
||
|
||
在现有项目中使用 Vant 时，可以通过 `npm` 进行安装：
|
||
|
||
```bash
|
||
# Vue 3 项目，安装最新版 Vant
|
||
npm i vant
|
||
|
||
# Vue 2 项目，安装 Vant 2
|
||
npm i vant@latest-v2
|
||
```
|
||
|
||
当然，你也可以通过 `yarn` 或 `pnpm` 进行安装：
|
||
|
||
```bash
|
||
# 通过 yarn 安装
|
||
yarn add vant
|
||
|
||
# 通过 pnpm 安装
|
||
pnpm add vant
|
||
```
|
||
|
||
## 快速上手
|
||
|
||
```js
|
||
import { createApp } from 'vue';
|
||
// 1. 引入你需要的组件
|
||
import { Button } from 'vant';
|
||
// 2. 引入组件样式
|
||
import 'vant/lib/index.css';
|
||
|
||
const app = createApp();
|
||
|
||
// 3. 注册你需要的组件
|
||
app.use(Button);
|
||
```
|
||
|
||
vant 也支持按需引入、CDN 引入等方式，详细说明见 [快速上手](https://vant-contrib.gitee.io/vant#/zh-CN/quickstart).
|
||
|
||
## 浏览器支持
|
||
|
||
Vant 2 支持现代浏览器以及 Android >= 4.0、iOS >= 8.0。
|
||
|
||
Vant 3/4 支持现代浏览器以及 Chrome >= 51、iOS >= 10.0（与 Vue 3 一致）。
|
||
|
||
## 官方生态
|
||
|
||
由 Vant 官方团队维护的项目如下：
|
||
|
||
| 项目 | 描述 |
|
||
| --- | --- |
|
||
| [vant-weapp](https://github.com/vant-ui/vant-weapp) | Vant 微信小程序版 |
|
||
| [vant-demo](https://github.com/vant-ui/vant-demo) | Vant 官方示例合集 |
|
||
| [vant-cli](https://github.com/vant-ui/vant/tree/dev/packages/vant-cli) | 开箱即用的组件库搭建工具 |
|
||
| [vant-icons](https://github.com/vant-ui/vant/tree/dev/packages/vant-icons) | Vant 图标库 |
|
||
| [vant-touch-emulator](https://github.com/vant-ui/vant/tree/dev/packages/vant-touch-emulator) | 在桌面端使用 Vant 的辅助库 |
|
||
|
||
## 社区生态
|
||
|
||
由社区维护的项目如下，欢迎补充：
|
||
|
||
| 项目 | 描述 |
|
||
| --- | --- |
|
||
| [3lang3/react-vant](https://github.com/3lang3/react-vant) | 参照 Vant 打造的 React 框架移动端组件库 |
|
||
| [rc-ui-lib](https://github.com/rancui/rc-ui-lib) | 参照 Vant 打造的 React 框架移动端组件库 |
|
||
| [vant-aliapp](https://github.com/ant-move/Vant-Aliapp) | Vant 支付宝小程序版 |
|
||
| [taroify](https://gitee.com/mallfoundry/taroify) | Vant Taro 版 |
|
||
| [vant-theme](https://github.com/Aisen60/vant-theme) | Vant 在线主题预览工具 |
|
||
| [@antmjs/vantui](https://github.com/antmjs/vantui) | 基于 Vant Weapp 开发的多端组件库，同时支持 Taro 和 React |
|
||
| [sfc-playground-vant](https://github.com/zhixiaoqiang/sfc-playground-vant) | Vant Playground. 当前仅支持 Vant 3.0 以上 |
|
||
|
||
## 链接
|
||
|
||
- [详细文档](https://vant-contrib.gitee.io/vant)
|
||
- [更新日志](https://vant-contrib.gitee.io/vant#/zh-CN/changelog)
|
||
- [Gitter 讨论组](https://gitter.im/vant-contrib/discuss?utm_source=share-link&utm_medium=link&utm_campaign=share-link)
|
||
|
||
## 手机预览
|
||
|
||
可以手机扫码以下二维码访问手机端 demo：
|
||
|
||
<img src="https://fastly.jsdelivr.net/npm/@vant/assets/preview-qrcode.png" width="220" height="220" >
|
||
|
||
## 核心团队
|
||
|
||
以下是 Vant 和 Vant Weapp 的核心贡献者们：
|
||
|
||
| [](https://github.com/chenjiahan/) | [](https://github.com/cookfront/) | [](https://github.com/w91/) | [](https://github.com/pangxie1991/) | [](https://github.com/rex-zsd/) | [](https://github.com/nemo-shen/) | [](https://github.com/Lindysen/) | [](https://github.com/JakeLaoyu/) |
|
||
| :-: | :-: | :-: | :-: | :-: | :-: | :-: | :-: |
|
||
| [chenjiahan](https://github.com/chenjiahan/) | [cookfront](https://github.com/cookfront/) | [wangnaiyi](https://github.com/w91/) | [pangxie](https://github.com/pangxie1991/) | [rex-zsd](https://github.com/rex-zsd/) | [nemo-shen](https://github.com/nemo-shen/) | [Lindysen](https://github.com/Lindysen/) | [JakeLaoyu](https://github.com/JakeLaoyu/) |
|
||
|
||
## 贡献者们
|
||
|
||
感谢以下小伙伴们为 Vant 发展做出的贡献：
|
||
|
||
<a href="https://github.com/vant-ui/vant/graphs/contributors">
|
||
<img src="https://opencollective.com/vant/contributors.svg?width=890&button=false" alt="contributors">
|
||
</a>
|
||
|
||
## 贡献指南
|
||
|
||
修改代码请阅读我们的 [贡献指南](https://vant-contrib.gitee.io/vant/#/zh-CN/contribution)。
|
||
|
||
使用过程中发现任何问题都可以提 [Issue](https://github.com/vant-ui/vant/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/vant-ui/vant/pulls)。
|
||
|
||
## 开源协议
|
||
|
||
本项目基于 [MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89) 协议，请自由地享受和参与开源。
|