Repository: youzan/vant-weapp
Stars: 18353
README.md
<p align="center">
<img alt="logo" src="https://img.yzcdn.cn/vant/logo.png" width="120" style="margin-bottom: 10px;">
</p>
<h3 align="center">轻量、可靠的小程序 UI 组件库</h3>
<p align="center">
<img src="https://img.shields.io/npm/v/@vant/weapp.svg?style=for-the-badge" alt="npm version" />
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge&color=#4fc08d" />
<img src="https://img.shields.io/npm/dt/@vant/weapp.svg?style=for-the-badge&color=#4fc08d" alt="downloads" />
<img src="https://img.shields.io/npm/dm/@vant/weapp.svg?style=for-the-badge&color=#4fc08d" alt="downloads" />
</p>
<p align="center">
🔥 <a href="https://vant.pro/vant-weapp/">文档网站（国内）</a>
🔥 <a href="https://vant-ui.github.io/vant-weapp/">文档网站（GitHub）</a>
🚀 <a href="https://github.com/vant-ui/vant" target="_blank">Vue 版</a>
</p>
---
介绍
Vant 是一个轻量、可靠的移动端组件库，于 2017 年开源。
目前 Vant 官方提供了 Vue 2 版本、Vue 3 版本和微信小程序版本，并由社区团队维护 React 版本和支付宝小程序版本。
预览
扫描下方小程序二维码，体验组件库示例。注意：因微信审核机制限制，目前示例小程序不是最新版本，可以 clone 代码到本地开发工具预览
<img src="https://img.yzcdn.cn/vant-weapp/qrcode-201808101114.jpg" width="200" height="200" style="margin-top: 10px;" >
使用之前
使用 Vant Weapp 前，请确保你已经学习过微信官方的 小程序简易教程 和 自定义组件介绍。
安装
方式一. 通过 npm 安装 (推荐)
小程序已经支持使用 npm 安装第三方包，详见 npm 支持
通过 npm 安装
npm i @vant/weapp -S --production通过 yarn 安装
yarn add @vant/weapp --production安装 0.x 版本
npm i vant-weapp -S --production方式二. 下载代码
直接通过 git 下载 Vant Weapp 源代码，并将 dist 目录拷贝到自己的项目中。
git clone https://github.com/youzan/vant-weapp.git使用组件
以按钮组件为例，只需要在 json 文件中引入按钮对应的自定义组件即可
{
"usingComponents": {
"van-button": "/path/to/vant-weapp/dist/button/index"
}
}接着就可以在 wxml 中直接使用组件
<van-button type="primary">按钮</van-button>在开发者工具中预览
安装项目依赖
npm install执行组件编译
npm run dev打开微信开发者工具，把vant-weapp/example目录添加进去就可以预览示例了。
PS：关于 van-area Area 省市区选择组件，地区数据初始化可以直接在云开发环境中导入vant-weapp/example/database_area.JSON 文件使用。
基础库版本
Vant Weapp 最低支持到小程序基础库 2.6.5 版本。
链接
- 文档网站（GitHub）
- 文档网站（国内）
- 意见反馈
- 设计资源
- 更新日志
- 官方示例
核心团队
以下是 Vant 和 Vant Weapp 的核心贡献者们：
|  |  |  |  |  |  |
| :-: | :-: | :-: | :-: | :-: | :-: |
| chenjiahan | cookfront | wangnaiyi | pangxie | rex-zsd | nemo-shen |
|  |  |  |  |  |  |
| :-: | :-: | :-: | :-: | :-: | :-: |
| Lindysen | JakeLaoyu | landluck | wjw-gavin | inottn | zhousg |
贡献者们
感谢以下小伙伴们为 Vant Weapp 发展做出的贡献：
<a href="https://github.com/youzan/vant-weapp/graphs/contributors">
<img src="https://opencollective.com/vant-weapp/contributors.svg?width=890&button=false" alt="contributors">
</a>
开源协议
本项目基于 MIT协议，请自由地享受和参与开源。