快速上手

使用之前

在开始使用之前，你需要先阅读 微信小程序自定义组件 的相关文档。

如何使用

  1. 通过 npm 安装，需要依赖小程序基础库 2.2.1 以上版本，同时依赖开发者工具的 npm 构建。具体详情可查阅 官方 npm 文档。
  2. 通过 GitHub 下载 Wux Weapp 的代码，然后 将dist/ 目录拷贝到自己的项目中。按照如下的方式使用组件，以 Button 为例，其它组件在对应的文档页查看：

在 page.json 中引入组件

  1. "usingComponents": {
  2.     "wux-button": "../../dist/button/index"
  3. }

在 page.wxml 中使用组件

  1. <wux-button size="small" />
  2. <wux-button size="default" />
  3. <wux-button size="large" />

组件库文件体积过大的问题

随着组件库越来越丰富，文件的体积也越来越大，某些时候我们可能只需要其中的一个或多个组件，如果直接引入整个组件库的话是不合适的，这时候就需要我们将要使用到组件给单独抽离出来，也很简单直接拷贝 dist/ 目录下对应的组件即可，当然某些组件存在依赖关系，则抽离过程会相对复杂一些，以 ActionSheet、Badge、Button 为例。

  1. demo/
  2.   |-actionsheet/
  3.   |-animation-group/
  4.   |-backdrop/
  5.   |-badge/
  6.   |-button/
  7.   |-helpers/
  8.   |-index.js
  • 首先将 dist/ 目录下对应组件（如 actionsheet）拷贝至 demo 目录；
  • 其次看其对应目录下 index.json 是否存在依赖组件，若存在则一一拷贝；
  • 然后看组件是否依靠 JavaScript 主动调用（查看对应文档可得知或存在 index.js 文件中），是则拷贝 index.js 文件，并删除不需要的组件引用；
  • 最后查看组件目录下 index.js 是否存在对帮助方法的引用，若存在则拷贝 helpers 目录（抑或直接拷贝不管是否存在引用）。

预览

您可以扫描下方的小程序码体验或用 微信web开发者工具 打开 example 目录（请注意，是 example 目录，不是整个项目）。

logo