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…

What is this?Vant Weapp is a lightweight, reliable UI component library for WeChat mini programs, open-sourced in 2017 as one of the official flavors of the Vant mobile component family.
Is this the Vue version of Vant, or something different?This is the WeChat Mini Program build — native mini program custom components, not Vue. Vant officially ships Vue 2, Vue 3 and WeChat versions, while the React and Alipay Mini Program versions are maintained by community teams.
How do I add it to my mini program project?Install via npm (recommended) or clone the repo and copy the dist directory into your project, then register the components you need in your page's json file and use them directly in wxml.
Do I need to already know WeChat mini program development to use it?Yes — the README assumes you have already studied WeChat's official Mini Program tutorial and the custom components guide. This is a UI layer on top of the platform, not a starter course.
Any version requirements or gotchas I should know about?Your mini program must run on base library 2.6.5 or newer. Also, the QR-code demo mini program is not the latest build due to WeChat's review process — clone the repo to preview the newest version in DevTools instead.
How can I try the components before using them in my own project?Scan the QR code in the README to open the demo mini program, or clone the repo and add the vant-weapp/example directory to WeChat DevTools to preview all examples locally — cloning also gets you the newest version, since the published demo lags behind.
What is the van-area component and does it come with region data?It is the province/city/district picker. It ships without data out of the box — you initialize it by importing the vant-weapp/example/databasearea.JSON file into your WeChat cloud development environment.
Creator
youzan
Size
20.9 MB
Stars
18.5K
Age
9y
Commits · 90 Days