Skip to content

Pro 配置概览

@aieditor/pro 建立在 aieditor Core 之上。AiEditorProOptions 继承 Core 的全部选项,并通过少量 Pro 专属选项启用分页、审阅、协作和 AI 文档处理能力。

安装与初始化

bash
npm install aieditor @aieditor/pro
ts
import {AiEditorPro} from '@aieditor/pro'
import 'aieditor/style.css'
import '@aieditor/pro/style.css'

const editor = new AiEditorPro({
  element: '#editor',
  documentStyle: 'word',
  pagination: true,
})

Core 的 elementcontenteditabletoolbarsidebartranslationsproductExtensions 等选项仍然有效。Pro 只在对应选项存在时安装额外能力。

Pro 选项

选项类型启用内容
paginationboolean | PaginationConfig纸张、分页、页眉页脚、页码和版心辅助线。
formatMarksboolean空格、制表符、硬换行和段落结束标记。默认 true
collaborationCollaborationConfigYjs/Hocuspocus 实时协作。
trackChangesTrackChangesConfig插入、删除、格式和节点修订。
commentsboolean | CommentsConfig批注锚点、线程和批注 Sidebar。
translationTranslationConfig一键翻译提案和翻译 Sidebar。
documentCompareDocumentCompareConfig文档差异标记和 AI 摘要 Sidebar。

能力组合

  • trackChangescomments 可以同时启用,二者共享评论数据和权限。
  • translationdocumentCompare 只生成提案或摘要,用户确认后才写回文档。
  • 启用 collaboration 后,Pro 会关闭 Core 本地 undoRedo,并忽略 content,由共享 Y.Doc 提供初始内容。
  • paginationformatMarks 只影响编辑视图,不改变普通正文的 Tiptap JSON 结构。

详细配置请按能力查看分页布局实时协作修订与批注等页面。

公共入口

Pro 包只通过 @aieditor/pro 导出公共能力;Core 的类型和实例仍从 aieditor 导入。不要从商业包或 Core 的 src 目录导入内部文件。