← API 参考 | 字体配置 → · 批注修订 →
- 静态资源:将 OnlyOffice SDK(含
web-apps/、sdkjs/、fonts/、x2t/)放到站点可访问目录,默认 public/packages/onlyoffice/9.4.0-develop/。自定义字体需在 AllFonts.js 的 __custom_font_registry__ 中注册,详见 字体配置。
- 环境变量(可选):
NEXT_PUBLIC_APP_ROOT=/packages/onlyoffice/9.4.0-develop,与 STATIC_RESOURCE.onlyoffice.root 一致。
- x2t 资源:
x2t/x2t.js 为普通 JS 文本,x2t.wasm 为 Brotli 预压缩文件;无需为 x2t.wasm 配置 Content-Encoding: br,Worker 内 x2t-assets 会自动解压。
- DOM 容器:页面需预留编辑器挂载点(见 快速开始)。
- 初始化:
OnlyOfficeManager.create / createWithFile 和 EditorManager.create 内部会自动调用 initializeOnlyOffice(),一般无需手动初始化。
- 容器元素:
- 单实例:页面中存在
id={ONLYOFFICE_ID} 的节点,父级使用 onlyoffice-container 类名。
- 多实例:每个实例使用唯一
containerId,父级设置 data-onlyoffice-container-id。
- 文件类型:文件扩展名需与内容一致。
- 事件清理:组件卸载时取消 EventBus 监听,并
destroy() 编辑器实例。
- 异步操作:
create / openDocument / export / downloadExport 等为异步,使用 await。
- 多实例资源隔离:各实例独立维护
media 映射;图片上传通过实例级 writeFile 路由。
- 容器 ID 唯一性:多实例下
containerId 不可重复。
- 保存事件选择:需要二进制数据用
SAVE_DOCUMENT / export();仅需保存成功提示可监听 ONSAVE。
- 只读导出:只读模式下
export() 直接返回缓存数据,不调用 downloadAs。
- 打开文件顺序:使用
createWithFile 时,应先 fetch 得到 File,再调用挂载 API。
.docx — Word 2007+
.doc — Word 97-2003
.odt — OpenDocument Text
.rtf — Rich Text Format
.txt — 纯文本
.xlsx — Excel 2007+
.xls — Excel 97-2003
.ods — OpenDocument Spreadsheet
.csv — CSV
.pptx — PowerPoint 2007+
.ppt — PowerPoint 97-2003
.odp — OpenDocument Presentation