插件文件结构说明

插件目录中的内容可以当成普通小程序进行编写，用来对插件进行预览、调试与审核。一个插件可以包含多个自定义组件、页面和一组JS接口。

1. 插件目录结构

插件的基本文件结构如下：

components

├── custom-component.js // 插件提供的自定义组件（可以有多个）

├── custom-component.json

pages

├── plugin-page.js // 插件提供的页面（可以有多个，自基础库2.1.1支持）

├── plugin-page.json

plugin.js // 插件的JS接口

plugin.json // 插件配置文件

插件配置文件

向使用者小程序开放的所有自定义组件、页面和JS接口都必须在插件配置文件（plugin.json）中明确列出。格式如下：

{
  "publicComponents": {
    "custom-component": "components/custom-component"
  },
  "pages": {
    "plugin-page": "pages/plugin-page"
  "main": "plugin.js"
}

上述配置表示向使用者小程序开放一个自定义组件 custom-component、一个页面 plugin-page，以及 plugin.js 下导出的所有JS接口。

自定义组件编写

插件的自定义组件与普通小程序自定义组件的编写方式基本相同，每个组件由 .fxml、.ftss、.js 和 .json 四个文件组成。在JSON文件中引用自定义组件时，需使用 plugin:// 协议指定插件引用名和组件名，例如：

{
  "usingComponents": {
    "custom-component": "plugin://myPlugin/custom-component"
  }
}

插件页面支持

插件从小程序基础库2.1.1开始支持页面。插件可以定义多个页面，并在其自定义组件或其他页面中跳转，也可以由使用者小程序跳转。插件页面的编写方式与普通小程序页面相同，每个页面由 .fxml、.ftss、.js 和 .json 组成。

插件页面跳转

插件内跳转页面时，可以使用 <navigator> 组件。当跳转到自身页面时，URL 格式需使用 plugin:// 前缀，例如：

<navigator url="plugin://myPlugin/plugin-page"></navigator>

插件也可在页面逻辑中调用 ft.navigateTo 进行跳转，URL 格式与 navigator 组件相同。

JS接口导出

插件可以在其接口文件（plugin.js）中提供JS接口，供使用者小程序调用。例如：

module.exports = {
  myMethod: function() {
    // 插件提供的接口逻辑
  }
}

使用者小程序可通过 requirePlugin 方法加载插件接口并使用。

插件预览与审核

在手机预览或提交审核插件时，系统会使用一个特殊的小程序来加载 miniprogram 文件夹下的代码，从而预览插件的实际效果。

插件上传流程

开发者如需上传自有插件，需进入 「小程序管理-小程序插件」 页面，点击 「新增插件」 按钮，填写插件名称、头像和介绍信息。完成新建后，点击 「更新插件」，填写版本号、更新日志，并上传代码包，即可完成插件的上传。