插件使用

插件使用

一、添加插件

在使用某一个插件前，需要在小程序控制台的“能力管理-插件中心–插件市场”申请所需要的插件。

选中所需要的插件后，点击“申请使用”，填写申请使用的原因，提交申请，等待申请审批。

二.使用插件前

开发者需要在小程序的app.json中声明需要使用的插件，示例代码如下：

{
  "plugins": {
    "myPlugin": {
    "version": "1.0.0", 
    "provider": "2019235609092837"
    },
    //如需声明多个插件，重复添加自定义字段即可
    "yourPlugin": {
    "version": "1.0.0", 
    "provider": "2019235609090000"  
    }
  }
}

其中：

Plugins：可以使用多个插件，每个插件声明以一个使用者自定义的插件引用名（上述代码中的myPlugin和yourPlugin）作为标识。

Version：明确插件的版本号

Provider：明确引用的插件ID

其中，插件ID可在“能力管理-插件中心–个人中心-我的申请”中找到相应插件的ID

注意： 同一个插件ID不能多次声明使用。

三、使用插件

为了正确地使用插件，使用者应该查看相应插件详情页中由插件开发者所提供的“使用指南”，阅读由插件开发者提供的插件开发文档。通过文档来明确插件提供的自定义组件、页面名称及提供的 js 接口规范等。

组件

可使用基础组件和自定义组件，插件的自定义组件和普通的自定义组件使用方法类似。在 json 文件中定义需要引用的插件自定义组件时，通过 plugin:// 协议指明需要引用的插件自定义组件，代码示例如下所示：

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

页面

跳转到插件页面时，URL 使用plugin:// 前缀，格式为 plugin://PLUGIN_NAME/PLUGIN_PAGE，示例代码如下所示：

<navigator url="plugin://myPlugin/hello">
        Go to pages/hello page!
</navigator>

也可以使用 API 进行跳转，示例代码如下：

my.navigateTo({
  url: 'plugin://myPlugin/hello',
})

Js接口

使用插件的 js 接口时，可以使用 requirePlugin 方法。示例代码如下所示：

const myPlugin = requirePlugin('myPlugin');
myPlugin.helloApi();
const word = myPlugin.world;

该示例先通过 requirePlugin 引用插件 API，然后访问插件暴露的 helloApi函数以及 world 变量。

注意事项：

1.当前版本IDE不支持插件。IDE无法编译和上传插件或带插件的小程序。若需要发布带插件的小程序，请打开小程序控制台，在开发管理中上传代码包。

2.当前插件能力暂时不支持behavior: jd://component-export ，暂时请不要使用selectComponent选择插件内的组件。