跳到正文
QuireKit
插件文档
Alpha · API 持续演进
Classic 产品扩展查看 Markdown ↗

ClassicWordKit · Classic Word 完整装配

组合 Word 领域扩展、布局 profile 与产品控件。多数接入使用 createClassicWordPreset;此层用于自行定义产品预设。

组合 Word 领域扩展、布局 profile 与产品控件。多数接入使用 createClassicWordPreset;此层用于自行定义产品预设。

@quirekit/classic-docx · Commercial

编辑器适用范围

层次:Classic 产品适配

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

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

接入

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

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

先使用 Word 预设。这里的单项适配器用于自定义预设或替换子项;不能向已有装配再追加同名扩展。

ts

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

按编辑器接入

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

Classic · 直接支持

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

createClassicWordPreset
ts

配置

下面是扩展自身的默认选项。预设可以覆盖这些值;它们不等于当前文档属性。配置方法见配置插件。

page

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

类型:WordPageOptions

默认:{}

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

paragraphTypes

Word kit 装配的段落类型名,供样式、编号和修订等领域共同使用。

类型:readonly string[]

默认:["paragraph", "heading"]

blockInteraction

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

类型:false | { readonly requirePortableIdentity?: boolean; }

默认:{}

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

contentControl

是否装配行内及相关结构内容控件能力。

类型:boolean

默认:true

contentControlDisplayMode

内容控件的初始会话显示策略。

类型:"alwaysShow" | "automatic" | "hide"

默认:"automatic"

contentControlAuthoringMode

内容控件的初始模板或填写模式。

类型:"fill" | "template"

默认:"template"

table

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

类型:boolean

默认:true

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

drawing

是否装配 Word 图片与绘图能力。

类型:boolean

默认:true

featureExtensions

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

类型:Partial<ClassicWordKitFeatureExtensions> | null

默认:null

symbol

是否装配符号目录与插入入口。

类型:boolean

默认:true

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

类型:boolean

默认:true

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

linkColor

Word 产品中新链接的默认显示颜色。

类型:string

默认:"#4b67f2"

toolbar

是否安装该领域的产品工具栏。

类型:boolean

默认:true

ribbon

是否向 Classic 功能区贡献控件。直接使用适配器与由预设装配时的值可能不同。

类型:boolean

默认:true

contextMenu

是否贡献上下文菜单入口。

类型:boolean

默认:false

ruler

是否安装 Word 产品标尺。

类型:boolean

默认:true

styleUserDefaultsStore

个人样式默认值的宿主读写接口,未提供时不承诺跨会话保存。

类型:WordParagraphStyleUserDefaultsStore | null

默认:null

proofing

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

类型:false | Partial<ProofingExtensionOptions>

默认:{}

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

命令与运行方式

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

下一步

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

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

QuireKitQuireKit · Core、插件与 Classic 文档