91 lines
2.9 KiB
Markdown
91 lines
2.9 KiB
Markdown
<p align="center">
|
|
<img alt="logo" src="https://img.yzcdn.cn/vant/logo.png" width="120" style="margin-bottom: 10px;">
|
|
</p>
|
|
<h3 align="center" style="margin: 30px 0 35px;">轻量、可靠的移动端 Vue 组件库</h3>
|
|
|
|
<p align="center">
|
|
<img src="https://img.shields.io/npm/v/vant.svg?style=flat-square" alt="npm version" />
|
|
<img src="https://img.shields.io/codecov/c/github/youzan/vant/dev.svg?style=flat-square" alt="Coverage Status" />
|
|
<img src="https://travis-ci.org/youzan/vant.svg?branch=master" alt="Build Status" />
|
|
<img src="https://img.shields.io/npm/dt/vant.svg?style=flat-square" alt="downloads" />
|
|
<img src="https://img.shields.io/npm/dm/vant.svg?style=flat-square" alt="downloads" />
|
|
<img src="https://img.badgesize.io/https://unpkg.com/vant/lib/vant.min.js?compression=gzip&style=flat-square&label=JS%20gzip%20size" alt="JS Gzip Size" />
|
|
<img src="https://img.badgesize.io/https://unpkg.com/vant/lib/index.css?compression=gzip&style=flat-square&label=CSS%20gzip%20size" alt="CSS Gzip Size" />
|
|
</p>
|
|
|
|
<p align="center">
|
|
🔥 <a href="https://youzan.github.io/vant">文档网站</a>
|
|
|
|
🇬🇧 <a href="./README.md">英文版介绍</a>
|
|
|
|
🚀 <a href="https://github.com/youzan/vant-weapp" target="_blank">小程序版</a>
|
|
</p>
|
|
|
|
---
|
|
|
|
## 特性
|
|
|
|
* 55+ 个组件
|
|
* 90% 单元测试覆盖率
|
|
* 完善的中英文文档和示例
|
|
* 支持按需引入
|
|
* 支持主题定制
|
|
* 支持国际化
|
|
* 支持 TS
|
|
* 支持 SSR
|
|
|
|
## 安装
|
|
|
|
```bash
|
|
# 通过 npm 安装
|
|
npm i vant -S
|
|
|
|
# 通过 yarn 安装
|
|
yarn add vant
|
|
```
|
|
|
|
## 快速上手
|
|
|
|
```js
|
|
import Vue from 'vue';
|
|
import { Button } from 'vant';
|
|
import 'vant/lib/index.css';
|
|
|
|
Vue.use(Button);
|
|
```
|
|
|
|
vant 也支持按需引入、CDN 引入等方式，详细说明见 [快速上手](https://youzan.github.io/vant#/zh-CN/quickstart).
|
|
|
|
## 贡献代码
|
|
|
|
修改代码请阅读我们的 [开发指南](https://youzan.github.io/vant/#/zh-CN/contribution)。
|
|
|
|
使用过程中发现任何问题都可以提 [Issue](https://github.com/youzan/vant/issues) 给我们，当然，我们也非常欢迎你给我们发 [PR](https://github.com/youzan/vant/pulls)。
|
|
|
|
## 浏览器支持
|
|
|
|
现代浏览器以及 Android 4.0+, iOS 6+.
|
|
|
|
## 链接
|
|
|
|
* [详细文档](https://youzan.github.io/vant)
|
|
* [更新日志](https://youzan.github.io/vant#/zh-CN/changelog)
|
|
* [Vant 示例仓库](https://github.com/youzan/vant-demo)
|
|
* [VantWeapp 小程序组件](https://github.com/youzan/vant-weapp)
|
|
|
|
## 手机预览
|
|
|
|
可以手机扫码以下二维码访问手机端 demo：
|
|
|
|
<img src="https://img.yzcdn.cn/vant/preview_qrcode_20180528.png" width="220" height="220" >
|
|
|
|
## 微信讨论群
|
|
|
|
欢迎大家加入 Vant 交流群一起讨论，添加下方微信并注明『加入 Vant 交流群』即可
|
|
|
|
<img src="https://img.yzcdn.cn/vant/wechat_20180606.png" width="220" height="292" >
|
|
|
|
## 开源协议
|
|
|
|
本项目基于 [MIT](https://zh.wikipedia.org/wiki/MIT%E8%A8%B1%E5%8F%AF%E8%AD%89) 协议，请自由地享受和参与开源。
|