mirror of
https://gitee.com/vant-contrib/vant-weapp.git
synced 2025-04-05 19:41:45 +08:00
120 lines
3.8 KiB
Markdown
120 lines
3.8 KiB
Markdown
<p>
|
|
<a href="https://github.com/youzan/"><img alt="logo" width="36px" src="https://img.yzcdn.cn/public_files/2017/02/09/e84aa8cbbf7852688c86218c1f3bbf17.png" alt="youzan">
|
|
</a>
|
|
</p>
|
|
<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>
|
|
|
|
---
|
|
|
|
## 概述
|
|
|
|
[Vant Weapp](https://youzan.github.io/vant-weapp) 是有赞移动端组件库 [Vant](https://github.com/youzan/vant) 的小程序版本，两者基于相同的视觉规范，提供一致的 API 接口，助力开发者快速搭建小程序应用。
|
|
|
|
## 预览
|
|
|
|
扫描下方小程序二维码，体验组件库示例：
|
|
|
|
<img src="https://img.yzcdn.cn/vant-weapp/qrcode-201808101114.jpg" width="200" height="200" style="margin-top: 10px;" >
|
|
|
|
## 文档
|
|
|
|
[https://youzan.github.io/vant-weapp](https://youzan.github.io/vant-weapp)
|
|
|
|
## 使用之前
|
|
|
|
使用 Vant Weapp 前，请确保你已经学习过微信官方的 [小程序简易教程](https://mp.weixin.qq.com/debug/wxadoc/dev/) 和 [自定义组件介绍](https://developers.weixin.qq.com/miniprogram/dev/framework/custom-component/)。
|
|
|
|
## 安装
|
|
|
|
### 方式一. 通过 npm 安装 (推荐)
|
|
|
|
小程序已经支持使用 npm 安装第三方包，详见 [npm 支持](https://developers.weixin.qq.com/miniprogram/dev/devtools/npm.html?search-key=npm)
|
|
|
|
```bash
|
|
# npm
|
|
npm i vant-weapp -S --production
|
|
|
|
# yarn
|
|
yarn add vant-weapp --production
|
|
```
|
|
|
|
### 方式二. 下载代码
|
|
|
|
直接通过 git 下载 Vant Weapp 源代码，并将`dist`目录拷贝到自己的项目中
|
|
```bash
|
|
git clone https://github.com/youzan/vant-weapp.git
|
|
```
|
|
|
|
## 使用组件
|
|
|
|
以按钮组件为例，只需要在 json 文件中引入按钮对应的自定义组件即可
|
|
|
|
```json
|
|
{
|
|
"usingComponents": {
|
|
"van-button": "/path/to/vant-weapp/dist/button/index"
|
|
}
|
|
}
|
|
```
|
|
|
|
接着就可以在 wxml 中直接使用组件
|
|
|
|
```html
|
|
<van-button type="primary">按钮</van-button>
|
|
```
|
|
|
|
## 在开发者工具中预览
|
|
|
|
```bash
|
|
# 安装项目依赖
|
|
npm install
|
|
|
|
# 执行组件编译
|
|
npm run dev
|
|
```
|
|
|
|
打开[微信开发者工具](https://mp.weixin.qq.com/debug/wxadoc/dev/devtools/download.html)，把`vant-weapp/example`目录添加进去就可以预览示例了。
|
|
|
|
## 基础库版本
|
|
|
|
Vant Weapp 最低支持到小程序基础库 1.9.9 版本
|
|
|
|
## 迁移指南
|
|
|
|
Vant Weapp 是基于有赞 Zanui 组件库进行的品牌升级，对于仍在使用 Zanui 的用户，建议逐渐使用 Vant Weapp 替换原有的组件。
|
|
|
|
Zanui 后续会进入维护状态，仓库地址为：[https://github.com/youzan/zanui-weapp](https://github.com/youzan/zanui-weapp)
|
|
|
|
## 链接
|
|
|
|
* [更新日志](https://github.com/youzan/vant-weapp/blob/dev/docs/markdown/changelog.md)
|
|
* [意见反馈](https://github.com/youzan/vant-weapp/issues)
|
|
* [加入我们](https://job.youzan.com)
|
|
* [Vant: 移动端 Vue UI](https://github.com/youzan/vant)
|
|
* [React: PC 端 React UI](https://www.youzanyun.com/zanui/zent)
|
|
|
|
## 微信讨论群
|
|
|
|
欢迎大家在微信上联系我们，添加下方微信并注明『交流 vant-weapp』即可
|
|
|
|
<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)协议，请自由地享受和参与开源。
|
|
|
|
## 贡献
|
|
|
|
如果你有好的意见或建议，欢迎给我们提 [issue] 或 [PR]，为优化 [vant-weapp] 贡献力量
|
|
|
|
[vant-weapp]: https://github.com/youzan/vant-weapp
|
|
[issue]: https://github.com/youzan/vant-weapp/issues/new
|
|
[PR]: https://github.com/youzan/vant-weapp/compare
|
|
[MIT]: http://opensource.org/licenses/MIT
|
|
[小程序简易教程]: https://mp.weixin.qq.com/debug/wxadoc/dev/
|
|
[小程序框架介绍]: https://mp.weixin.qq.com/debug/wxadoc/dev/framework/MINA.html
|
|
[微信开发者工具]: https://mp.weixin.qq.com/debug/wxadoc/dev/devtools/download.html
|