跳到主要内容

概述

ONLYOFFICE 插件是使用 HTML、CSS 和 JavaScript 构建的 Web 应用,运行在文档、电子表格、演示文稿和 PDF 编辑器中。插件可以打开面板或窗口、添加工具栏按钮和上下文菜单项,也可以在后台运行,并通过插件 API 读取和修改文档。插件可在 ONLYOFFICE 文档、ONLYOFFICE 协作空间和 ONLYOFFICE 桌面编辑器中使用。

如果您希望直接开始编写代码,请前往快速入门指南,或在交互式 Playground 中体验。

您可以构建什么​

构建与 ONLYOFFICE 原生体验融为一体的复杂集成。

适用场景:

  • 嵌入外部内容(YouTube、媒体库)
  • 第三方集成(Translator、Zotero、CRM 系统)
  • 高级处理(OCR、图像处理、数据可视化)
  • 自定义工作流(表单构建器、审批系统、模板)

开发概况:

  • 技能:中级 | 技术栈:HTML/CSS/JavaScript
  • 分发方式:编辑器内置的 ONLYOFFICE 插件市场(如何提交),或私有部署

插件的限制​

  • 无法直接访问编辑器的内部 DOM 或 JavaScript 作用域
  • 无法访问用户计算机上的文件系统
  • 无法绕过 API 执行插件 SDK 未公开的操作

这种沙箱化设计是有意为之的——无论插件做什么,都能保持编辑器的稳定与安全。

插件架构插件架构

方案对比​

不确定哪种方案适合您的使用场景?了解插件与宏及自定义 AI 工具的对比。

ONLYOFFICE API Scheme ONLYOFFICE API Scheme

功能插件宏AI 工具
是什么?嵌入编辑器的 HTML/CSS/JS 应用文档中的 JavaScript 代码插件 + AI 提供商集成
安装需要(应用市场或手动)无需(嵌入文档)需要(与插件相同)
用户界面✅ 完整自定义 UI❌ 无 UI✅ 完整自定义 UI
外部 API✅ 支持(REST、GraphQL 等)❌ 不支持✅ 支持(需要 AI 服务)
离线使用⚠️ 取决于功能✅ 完全离线❌ 需要网络
技能要求中级入门高级
分发方式应用市场、GitHub、私有复制粘贴、模板应用市场、私有
最适合可复用工具、集成个人自动化AI 驱动功能
框架支持✅ 任意(React、Vue、Angular 或纯 HTML)❌ 仅限原生 JavaScript✅ 任意(与插件相同)

另请参阅:宏 | 自定义 AI 工具

故障排除​

如果插件不显示、窗口空白或 API 调用失败,请参阅常见错误及解决方案了解症状和解决方法,并参阅调试插件了解如何在开发者工具中检查正在运行的插件。

仍未解决?请在 ONLYOFFICE 论坛或 Stack Overflow 上提问,或在 GitHub Issues 中报告问题。

资源​

下一步​