vant-weapp README

The project's README from github.com/youzan/vant-weapp. As one markdown file: README.md.

logo

轻量、可靠的小程序 UI 组件库

npm version downloads downloads

🔥 文档网站(国内)   🔥 文档网站(GitHub)   🚀 Vue 版


介绍

Vant 是一个轻量、可靠的移动端组件库,于 2017 年开源。

目前 Vant 官方提供了 Vue 2 版本、Vue 3 版本和微信小程序版本,并由社区团队维护 React 版本和支付宝小程序版本。

预览

扫描下方小程序二维码,体验组件库示例。注意:因微信审核机制限制,目前示例小程序不是最新版本,可以 clone 代码到本地开发工具预览

使用之前

使用 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 版本。

链接

核心团队

以下是 Vant 和 Vant Weapp 的核心贡献者们:

chenjiahan cookfront w91 pangxie1991 rex-zsd nemo-shen
chenjiahan cookfront wangnaiyi pangxie rex-zsd nemo-shen
Lindysen JakeLaoyu landluck wjw-gavin inottn zhousg
Lindysen JakeLaoyu landluck wjw-gavin inottn zhousg

贡献者们

感谢以下小伙伴们为 Vant Weapp 发展做出的贡献:

contributors

开源协议

本项目基于 MIT协议,请自由地享受和参与开源。

vant-weapp (youzan/vant-weapp)

Searching Database…

这是什么?Vant Weapp 是一个轻量、可靠的微信小程序 UI 组件库,2017 年开源,是 Vant 移动端组件家族的官方版本之一。
这是 Vue 版的 Vant,还是别的东西?这是微信小程序版本——用的是小程序原生自定义组件,不是 Vue。Vant 官方提供 Vue 2、Vue 3 和微信小程序版本,而 React 版和支付宝小程序版由社区团队维护。
怎么把它加到我的小程序项目里?用 npm 安装(推荐方式),或者克隆仓库并把 dist 目录复制到你的项目里,然后在页面的 json 文件里注册需要的组件,就可以直接在 wxml 中使用了。
我需要先懂微信小程序开发才能用吗?需要——README 默认你已经学过微信官方的小程序教程和自定义组件指南。它只是搭建在平台之上的一层 UI,不是入门教程。
有版本要求或者要注意的坑吗?你的小程序必须运行在 2.6.5 或更新的基础库上。另外,由于微信的审核流程,演示用的小程序不是最新构建的版本——想预览最新版本,请克隆仓库后在开发者工具里查看。
在自己项目里用之前,怎么先体验一下这些组件?扫描 README 里的二维码打开演示小程序,或者克隆仓库,把 vant-weapp/example 目录添加到微信开发者工具里,在本地预览所有示例——克隆仓库还能拿到最新版本,因为已发布的演示版落后于代码。
van-area 组件是什么,自带地区数据吗?它是省/市/区选择器。它本身不带数据——你需要把 vant-weapp/example/databasearea.JSON 文件导入到你的微信云开发环境里来初始化。
Creator
youzan
Size
20.9 MB
Stars
18.5K
Age
9y
Commits · 90 Days