logo

创建一个插件

插件文件结构

插件文件目录需要包含最基本的 3 个部分:

your-plugin-directory/
├── manifest.json
├── main.js
└── ui.html
  • manifest.json: 插件配置文件。
  • main.js: 插件脚本文件的主入口。
  • ui.html: 插件 UI 的 HTML。

manifest.json 配置文件

每个插件都必须包含一个 manifest.json 文件,其中定义了插件的基础信息和配置项。以下是一个示例配置文件:

{ "name": "miaoduo-plugin", "id": "xxxxxxxxxxxxxxxxxxxxxx", "main": "code.js", "ui": "ui.html" }
  • name: 插件的名称。
  • id: 插件唯一标识符,通常不需要手动指定,在新建或发布插件时,会生成一个不重复的 id 值。主要用于插件发布和更新操作的隔离,每个插件唯一且和企业绑定。
  • main: JS 脚本的相对路径。
  • ui: 插件页面 HTML 的相对路径。

请根据你的实际需求修改 manifest.json 文件中的各项配置。

新建一个插件

你可以使用原生 HTML + CSS 实现 main.tsui.html,并在 manifest.json 指定 mainui 的路径,来创建一个插件。

你也可以在妙多中新建一个默认插件来初始化工作:

  1. 1.登录桌面客户端后,新建并进入一个文件。
  2. 2.从客户端菜单 -「插件」-「开发企业私有插件...」打开插件开发面板后,选择「新建插件」。
  3. 3.设置插件名称后,点击「创建到本地」为其设置本地存储路径。 'image.png'
  4. 4.插件创建完成。使用妙多新建的插件项目默认使用 Typescript / React / Webpack,请参考 README.md 编译出 main.jsui.html,即可在妙多中运行。

导入插件

你也可以将本地已编写好的插件项目直接导入到妙多中。

  1. 1.在插件开发面板中选择「导入插件」。
  2. 2.选择目标插件目录中的 manifest.json 文件。

妙多插件的大部分 API 与 Figma 兼容。因此,你也可以直接导入 Figma 插件。