小程序插件开发

微信小程序插件开发

微信小程序插件开发概述

创建插件开发模版

微信小程序插件分为页面组件接口三种。开发者可以使用 taro init 命令,然后选择生成微信小程序插件模版,即可在当前目录生成包含上述三种插件类型的 Taro 微信小程序插件项目。

修改 appid

创建完模版后,首先需要修改 project.conf.jsonappid 字段和 src/app.jsprodiver 字段为同一 appid。

项目结构

推荐的插件项目结构如下:

注意,最后发布的是 plugin 文件夹内的内容,插件的所有内容及除了 npm 包以外的依赖都应写在 plugin 文件夹内。src/pages 内的页面只是用于调试插件。

  1. ├── config 配置目录
  2. ├── src 源码目录
  3. |├── pages 调试页面目录,用于调试插件
  4. ||└── index
  5. |├── plugin 插件目录
  6. ||├── doc 插件文档目录
  7. ||├── component 组件插件目录
  8. ||├── page 页面插件目录
  9. ||├── index.js 接口插件文件
  10. ||└── plugin.json 插件配置文件
  11. |├── app.css 项目总通用样式
  12. |└── app.js 项目入口文件
  13. └──package.json
  14. └──package.config.json

编译项目

  1. taro build --plugin weapp
  2. taro build --plugin weapp --watch

添加小程序项目

在微信开发者工具中添加 Taro 插件项目根目录。

使用页面插件

plugin.json 的 pages 字段加入页面插件路径:

  1. {
  2. "pages":{
  3. "list":"pages/list/list"
  4. }
  5. }

页面使用路径: plugin://[app.js 中注册的插件名]/[plugin.json 中注册的页面名] 进行跳转。

  1. <Navigatorurl='plugin://myPlugin/list'>
  2. Go to pages/list!
  3. </Navigator>

使用组件插件

plugin.json 的 publicComponents 字段加入组件插件路径:

  1. {
  2. "publicComponents":{
  3. "avatar":"components/avatar/avatar"
  4. }
  5. }

在页面配置 config.usingComponents 中配置好插件名和插件路径(plugin://[app.js 中注册的插件名]/[plugin.json 中注册的组件名]):

  1. exportdefaultclassIndexextendsComponent{
  2. config ={
  3. usingComponents:{
  4. 'avatar':'plugin://myPlugin/avatar'
  5. }
  6. }
  7. }

Taro v1.3+ 组件插件接受外部 props 的问题

#3176

Taro v1.3 对 props 系统进行了改造,使得不能兼容原生组件通过 properties 传入的属性。

目前可以通过把所有需要传入组件插件的 props,通过借助 extraProps 属性来解决。

  1. // 常规 props 传递
  2. <Plugin title={this.state.name} desc={this.state.desc}/>
  3. // 在使用插件组件时需要改造成以下形式:
  4. const extraProps ={
  5. name:this.state.name,
  6. desc:this.state.desc
  7. }
  8. <Plugin extraProps={extraProps}/>

使用接口插件

plugin.json 的 main 字段加入接口插件路径:

  1. {
  2. "main":"index.js"
  3. }

页面中使用:

  1. const myPluginInterface =Taro.requirePlugin('myPlugin')
  2. exportdefaultclassIndexextendsComponent{
  3. componentWillMount (){
  4. myPluginInterface.sayHello()
  5. const answer = myPluginInterface.answer
  6. console.log('answer: ', answer)
  7. }

支付宝小程序插件开发

支付宝小程序插件开发概述

项目结构

目前支付宝小程序只支持开发页面插件,因此项目结构和普通 Taro 项目的一致。只需在源码目录下再增加 plugin.jsonplugin-mock.json 两个文件即可。

编译项目

  1. taro build --plugin alipay
  2. taro build --plugin alipay --watch