跳到正文
QuireKit
插件文档
Alpha · API 持续演进

Document · 文档根节点

定义整篇文档的根结构,要求至少一个块。创建最小 schema 时需要它;它不会提供可编辑段落或视图。

定义整篇文档的根结构,要求至少一个块。创建最小 schema 时需要它;它不会提供可编辑段落或视图。

@quirekit/extension-document · MIT

编辑器适用范围

层次:共享文档能力

编辑器状态所需装配与边界
Classic直接支持classicEditorPreset — 使用产品中立的 classicEditorPreset;已有能力由预设装配,不要重复追加。Word 预设会替换段落、标题和容器列表,不能把通用结构直接叠加到 Word 模型。
Block直接支持createBlockEditorPreset — createBlockEditor 默认预设已装配此能力。通过 preset 中对应子项配置;图形编辑使用预设注入的工作区,宿主仍负责保存和资源。不要重复安装同名扩展。

“直接支持”指已有上述产品装配;具体交互、宿主服务和格式支持仍有各自条件。状态与接入规则。许可独立显示。

接入

sh

在创建 Editor 时放入 extensions。挂载容器、视图和保存由宿主提供,见快速开始。

StarterKit 已包含此能力,在 StarterKit.configure() 的 document 子项中配置;设为 false 后才能单独安装同名替代。

ts

安装时按包声明选择兼容版本,外部可用版本以分发源为准。本站使用工作区 Alpha;许可标签来自入口所属包,使用条件见支持与许可。

按编辑器接入

以下片段沿用已挂载的宿主元素 element,宿主负责容器尺寸与保存;退出页面时调用 instance.destroy()。已有预设装配的能力不要再重复追加;需要宿主端口的入口应先完成下方配置。

Classic · 直接支持

使用产品中立的 classicEditorPreset;已有能力由预设装配,不要重复追加。Word 预设会替换段落、标题和容器列表,不能把通用结构直接叠加到 Word 模型。

classicEditorPreset
ts

配置

此入口没有独立的配置字段。文档属性通过领域命令设置;产品预设可能继续装配其他可配置子扩展。

命令与运行方式

以下命令由此扩展直接提供,均在当前 Editor 上调用。命令是否可用由已安装 schema、当前选区与保护策略决定;可以先用 editor.can() 查询。

命令参数签名
setDocumentFontFamilysetDocumentFontFamily(family: string)
setDocumentLatinFontFamilysetDocumentLatinFontFamily(family: string)
setDocumentEastAsiaFontFamilysetDocumentEastAsiaFontFamily(family: string)
setDocumentFontThemesetDocumentFontTheme(patch: DocumentFontThemePatch)

这里只展示参数签名。接界面时见命令与控件,正文变更继续经过同一事务与历史。

其他公开入口

  • Document · @quirekit/starter-kit

下一步

返回全部插件,或阅读配置插件区分配置、文档属性与命令。

自己定义能力时见扩展开发;搭建完整宿主时见构建产品。

QuireKitQuireKit · Core、插件与 Classic 文档