跳到主要内容
版本:4.x

微信小程序插件开发

Taro 支持开发微信小程序插件,本文将介绍主要用法。

信息

目前微信小程序仅支持使用 React 来进行开发

参考

开发步骤

1. 创建插件开发模版

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

项目结构

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

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

├── config                 配置目录
├── src 源码目录
| ├── pages 调试页面目录,用于调试插件
| | └── index
| ├── plugin 插件目录
| | ├── doc 插件文档目录
| | ├── components 组件插件目录
| | ├── pages 页面插件目录
| | ├── index.js 接口插件文件
| | └── plugin.json 插件配置文件
| ├── app.css 项目总通用样式
| └── app.js 项目入口文件
└── package.json
└── package.config.json

配置 appid

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

编译项目

taro build --plugin weapp
taro build --plugin weapp --watch

添加小程序项目

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

使用插件页面

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

plugin.json
{
"pages": {
"list": "pages/list/list"
}
}

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

<Navigator url="plugin://myPlugin/list">Go to pages/list!</Navigator>

插件页面获取小程序渲染层元素

// 通过 this.props.$scope 获取到小程序原生配置对象
const query = Taro.createSelectorQuery().in(this.props.$scope)
query
.select('#id')
.boundingClientRect()
.exec((res) => {
console.log(res)
})

genericsImplementation

支持使用 genericsImplementation 传入组件到插件页面,详细用法请看 Demo。

使用插件组件

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

plugin.json
{
"publicComponents": {
"avatar": "components/avatar/avatar"
}
}

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

export default class Index extends Component {
config = {
usingComponents: {
avatar: 'plugin://myPlugin/avatar',
},
}
}

插件组件接受外部 props

如果需要给插件传入参数,需要将参数统一放在组件的 props 中进行传入。

// 常规 props 传递
<Plugin title={this.state.name} desc={this.state.desc} />

// 在使用插件组件时需要改造成以下形式:
const extraProps = {
name: this.state.name,
desc: this.state.desc
}
<Plugin props={extraProps} />

插件组件事件传递

微信小程序的 props 支持传递函数,因此我们也可以通过给插件组件传入函数 props 达到事件传递的目的。

// 调用方传入事件回调函数
;<Plugin props={{ onSomeEvent() {} }} />

// 插件调用事件函数
this.props.onSomeEvent()

插件组件获取小程序渲染层元素

// 通过 this.props.$scope 获取到小程序原生配置对象
const query = Taro.createSelectorQuery().in(this.props.$scope)
query
.select('#id')
.boundingClientRect()
.exec((res) => {
console.log(res)
})

componentGenerics

暂不支持 componentGenerics

使用插件接口

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

plugin.json
{
"main": "index.js"
}

页面中使用:

const myPluginInterface = Taro.requirePlugin('myPlugin')

export default class Index extends Component {
componentWillMount () {
myPluginInterface.sayHello()
const answer = myPluginInterface.answer
console.log('answer: ', answer)
}