跳到主要内容

开发插件

要开发插件，请在本地创建一个文件夹，并将 index.html 和 config.json 文件放入其中。然后按照以下说明将该文件夹加载到编辑器中。

Web 编辑器​

  1. 启用 CORS 提供插件文件夹服务。编辑器从其他源获取 config.json 和其他插件文件，因此服务器必须发送 CORS 标头。例如，在插件文件夹中运行以下命令：

    npx http-server -p 8080 --cors

  2. 在 ONLYOFFICE Web 编辑器中打开任意文档。在浏览器开发者工具中，切换到 Console 选项卡，从下拉列表中选择 frameEditor，然后运行：

    Asc.editor.installDeveloperPlugin("http://localhost:8080/config.json");

    开发者控制台

该命令返回 true，插件将显示在插件选项卡中。如果返回 false，则表示无法获取或解析 config.json。该命令不会报告原因。请检查 URL，然后参阅插件文件被 CORS 阻止。

如果您可以控制集成的编辑器配置，也可以让插件在每次打开文档时自动加载：将其 config.json 的 URL 添加到 editorConfig.plugins.pluginsData 中。请参阅通过 config.json 添加插件。

插件文件相对于 config.json 所在的文件夹加载。重新加载页面后，插件仍保持安装状态（在同一浏览器中且编辑器地址相同）。更改插件文件后，请重新加载页面以加载新版本。

桌面编辑器​

  1. 将所有插件文件打包为 zip 压缩包，并将扩展名更改为 .plugin。所有插件文件和子文件夹都必须位于压缩包的根目录。

  2. 通过插件管理器安装插件。插件将被复制到 sdkjs-plugins 目录中，文件夹名称为不带 asc. 前缀的插件 guid，例如 {91EAC419-EF8B-440C-A960-B451C7DF3A37}：

    %LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\

    Sdkjs-plugins 文件夹

  3. 为避免每次更改后都重新打包插件，请将该文件夹替换为指向开发文件夹的符号链接。关闭桌面编辑器，删除已安装的插件文件夹，然后创建链接：

    以管理员身份运行：

    mklink /D "%LOCALAPPDATA%\ONLYOFFICE\DesktopEditors\data\sdkjs-plugins\{YOUR-GUID}" "C:\path\to\your\plugin"

更改插件文件后，请重新打开文档以加载新版本。

后续步骤​

要暂停并检查插件代码，请参阅调试插件。