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

createClassicWordDocxPlugin · DOCX 与 DOTX 文件服务

向 Classic 注册 Word 文档和模板的导入、导出服务及菜单。它属于 plugins,不放入 Core extensions。

向 Classic 注册 Word 文档和模板的导入、导出服务及菜单。它属于 plugins,不放入 Core extensions。

@quirekit/classic-docx · Commercial

编辑器适用范围

层次:Classic 产品适配

编辑器状态所需装配与边界
Classic直接支持这是 Classic 产品插件,加入 createClassicEditor 的 plugins;依赖的模型、宿主端口和服务必须按下方配置提供。
Block未支持Block 不消费 Classic 产品 contribution、plugins 或分页装配。请使用共享能力和 Block 适配入口,不能直接复制此入口的 Classic 配置。

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

接入

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

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

这是产品层接入:将产品插件放入 createClassicEditor 的 plugins,不要放进 Core 的 extensions。必填宿主端口见下面的配置。

ts

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

按编辑器接入

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

Classic · 直接支持

这是 Classic 产品插件,加入 createClassicEditor 的 plugins;依赖的模型、宿主端口和服务必须按下方配置提供。

ts

配置

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

codec

DOCX 解析与生成接口。未提供时使用产品默认 LitDocx codec。

类型:DocxCodec | undefined

默认:createWorkspaceLitDocxCodec()

pluginId

产品插件的唯一身份,同一实例内不能冲突。

类型:string | undefined

默认:"classic.docx"

serviceId

注册到产品的文件服务身份,菜单按此身份调用服务。

类型:string | undefined

默认:"docx"

fileName

建议导出的文件名,包含对应格式扩展名。

类型:string | undefined

默认:"document.docx"

templateServiceId

注册 Word 模板文件服务的身份。

类型:string | undefined

默认:"dotx"

templateFileName

建议导出的 DOTX 模板文件名。

类型:string | undefined

默认:"template.dotx"

onReport

文件操作完成后的结构化报告回调,用于呈现保真度、资源或损失诊断。

类型:((detail: ClassicWordDocxReportDetail) => void) | undefined

默认:undefined

命令与运行方式

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

其他公开入口

  • createClassicWordDocxPlugin · @quirekit/classic-docx/docx

下一步

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

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

QuireKitQuireKit · Core、插件与 Classic 文档