跳到正文
QuireKit
插件文档
Alpha · API 持续演进
产品预设与服务查看 Markdown ↗

createClassicWordPreset · Word 社区预设

创建包含文档模型、Word 布局与社区产品控件的预设,交给 createClassicEditor 的 preset。文件服务等可选能力仍按 plugins 显式装配。

创建包含文档模型、Word 布局与社区产品控件的预设,交给 createClassicEditor 的 preset。文件服务等可选能力仍按 plugins 显式装配。

@quirekit/classic-docx · Commercial

编辑器适用范围

层次:Classic 产品适配

编辑器状态所需装配与边界
Classic直接支持使用 createClassicWordPreset 装配 Word 模型、布局与产品适配;具体控件、开关、宿主服务及文件支持以本页说明为准。批注、修订和内容控件的完整创作界面另需 Pro。
Block未支持Block 不消费 Classic 产品 contribution、plugins 或分页装配。请使用共享能力和 Block 适配入口,不能直接复制此入口的 Classic 配置。

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

接入

当前 @quirekit/classic-docx 的包元数据标为 private。本站使用工作区源码;外部项目需先取得对应分发包,不能把下面的公开导出理解为已经能从公共 npm 安装。

此入口属于商业组件。使用前先取得相应分发与授权;安装命令仅适用于已配置该分发源的项目。

调用后把结果交给 createClassicEditor({ preset }),每次挂载独立解析扩展。

ts

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

按编辑器接入

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

Classic · 直接支持

使用 createClassicWordPreset 装配 Word 模型、布局与产品适配;具体控件、开关、宿主服务及文件支持以本页说明为准。批注、修订和内容控件的完整创作界面另需 Pro。

ts

配置

字段传入创建函数的 options。标为“必填”的端口由宿主提供;undefined 表示未显式配置,下面会说明创建层的回退。

id

当前预设的身份;构建自己的产品预设时提供独立名称。

类型:string | undefined

默认:"classic-word"

features

覆盖产品功能默认值。社区 Word 预设默认启用 table 与 drawing;审阅界面由专业版装配。

类型:ClassicEditorFeatureOptions | undefined

默认:undefined

plugins

在预设默认插件后追加的产品插件列表。

类型:readonly ClassicEditorPlugin[] | undefined

默认:[]

featureExtensions

替换 Word kit 的批注、修订与行内内容控件实现,可按挂载上下文解析。

类型:Partial<ClassicWordKitFeatureExtensions> | ((context: ClassicEditorPresetContext) => Partial<ClassicWordKitFeatureExtensions>) | undefined

默认:null

proofing

配置 Proofing 子扩展;允许 false 时可关闭此项。

类型:false | Partial<ProofingExtensionOptions> | undefined

默认:{}

子扩展的具体选项见 Proofing。是否可以设为 false,以本字段类型为准。

命令与运行方式

此入口没有直接声明可枚举的命令。组合扩展的命令由子扩展提供;产品插件通过 contribution 或文件服务工作。不能把安装入口名称当作命令调用。

其他公开入口

  • classicWordPreset · @quirekit/classic-docx

下一步

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

继续Classic 快速接入和配置与生命周期。开发自己的产品界面与服务时,见产品插件开发。

QuireKitQuireKit · Core、插件与 Classic 文档