Skip to content

配置概览

概述

AiEditor 的配置分为实例与生命周期、工具栏与菜单、Sidebar、文字与段落、内容组件、媒体上传、文档结构、校验和 AI。每个可独立配置的能力在左侧都有单独入口;类别概述用于解释能力之间的关系。

配置内容

ts
const editor = new AiEditor({
  element: '#editor',
  content: '<p>初始内容</p>',
  theme: 'light',
  toolbar: {style: 'compact'},
  fontSizes: [{label: '正文', value: '16px'}],
  uploader: {upload: uploadFile},
  onUpdate: (tiptapEditor) => saveDraft(tiptapEditor.getJSON()),
})

配置说明

类别主要配置使用场景
实例与生命周期elementcontent、事件、校验、模板挂载、保存、导入和工作台布局。
工具栏与菜单toolbartoolbar.menusbubbleMenu裁剪功能、调整布局,以及通过自定义菜单加入业务操作。
SidebarsidebaraiChatAI 对话和业务侧栏面板。
文字与段落字体、字号、颜色、行高、对齐、缩进品牌排版和格式规范。
内容组件链接、提及、表情、代码、表格、公式、详情结构化富内容。
媒体与上传图片、音频、视频、附件、uploader文件存储和媒体编辑。
文档结构documentStyle、目录、唯一 ID长文样式和结构锚点;分页与公文分别见 Pro 和公文版。
校验与历史contentSanitizationenableContentCheckundoRedo外部内容导入安全和撤销策略。
高级能力扩展管理器、AI 服务、数学配置、块拖拽业务 schema 和智能编辑。

配置对象只在实例创建时读取。支持运行时修改的能力会在对应页面列出 set* 方法;结构性配置变化时,应保存 内容、销毁实例并重新创建。

自定义配置组合

ts
const readonlyPreview = {
  editable: false,
  toolbar: {style: 'compact' as const},
  bubbleMenu: false as const,
  documentStyle: 'web' as const,
}

new AiEditor({element: '#preview', content: article.html, ...readonlyPreview})

完整类型索引见 AiEditorOptions API

分页配置已迁移到 Pro 分页布局,公文节点与配置已迁移到公文结构与配置