mirror of
https://gitee.com/vant-contrib/vant.git
synced 2025-04-06 03:57:59 +08:00
110 lines
4.1 KiB
Markdown
110 lines
4.1 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=for-the-badge" alt="npm version" />
|
||
<img src="https://img.shields.io/github/workflow/status/youzan/vant/CI/dev?style=for-the-badge" alt="npm version" />
|
||
<img src="https://img.shields.io/codecov/c/github/youzan/vant/dev.svg?style=for-the-badge&color=#4fc08d" alt="Coverage Status" />
|
||
<img src="https://img.shields.io/npm/dm/vant.svg?style=for-the-badge&color=#4fc08d" alt="downloads" />
|
||
<img src="https://img.badgesize.io/https://unpkg.com/vant/lib/vant.min.js?compression=gzip&style=for-the-badge&label=gzip%20size&color=#4fc08d" alt="Gzip Size" />
|
||
</p>
|
||
|
||
<p align="center">
|
||
🔥 <a href="https://youzan.github.io/vant">文档网站</a>
|
||
|
||
🚀 <a href="https://github.com/youzan/vant-weapp" target="_blank">小程序版</a>
|
||
</p>
|
||
|
||
---
|
||
|
||
## 特性
|
||
|
||
* 60+ 高质量组件
|
||
* 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 8.0+.
|
||
|
||
## 加入我们
|
||
|
||
**有赞前端团队**是由一群年轻、皮实、对技术饱含热情的小伙伴组成的，目前共有 100 多名前端工程师，分布在业务中台、电商、零售、美业、资产、赋能等业务线。
|
||
|
||
我们热爱分享和开源，崇尚用工程师的方式解决问题，因此造了很多工具来解决我们遇到的问题，目前我们维护的开源产品有：
|
||
|
||
<img src="https://img.yzcdn.cn/public_files/2019/07/22/f4b70763c55c8710c52c667ecf192c05.jpeg" width="320" height="303">
|
||
|
||
我们正在寻找更多优秀的小伙伴，一起拓展前端技术的边界，期待你的加入！
|
||
|
||
- <a target="_blank" href="https://app.mokahr.com/apply/youzan/6252#/job/96f5d2c7-e657-4d31-9244-195edc443a7f?_k=jf2141">职位详情</a>（Base: 杭州/深圳）
|
||
- <a target="_blank" href="https://tech.youzan.com/tag/front-end/">团队博客</a>
|
||
- <a target="_blank" href="https://github.com/youzan">开源项目</a>
|
||
|
||
## 生态
|
||
|
||
| 项目 | 描述 |
|
||
|-----|------|
|
||
| [vant-demo](https://github.com/youzan/vant-demo) | Vant 官方示例合集 |
|
||
| [vant-weapp](https://github.com/youzan/vant-weapp) | 微信小程序组件库 |
|
||
| [vant-cli](https://github.com/youzan/vant/tree/dev/packages/vant-cli) | 开箱即用的组件库搭建工具 |
|
||
| [vant-icons](https://github.com/youzan/vant/tree/dev/packages/vant-icons) | Vant 图标库 |
|
||
| [vant-touch-emulator](https://github.com/youzan/vant/tree/dev/packages/vant-touch-emulator) | 在桌面端使用 Vant 的辅助库 |
|
||
|
||
## 链接
|
||
|
||
* [详细文档](https://youzan.github.io/vant)
|
||
* [更新日志](https://youzan.github.io/vant#/zh-CN/changelog)
|
||
* [码云镜像](https://gitee.com/organizations/vant-contrib)
|
||
|
||
## 手机预览
|
||
|
||
可以手机扫码以下二维码访问手机端 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) 协议，请自由地享受和参与开源。
|