createClassicDocumentTemplatePlugin · 文档模板库
注册完整文档模板目录与创建入口。provider 返回模板,createDocument 决定如何开启独立副本;它与导出样式模板不同。
注册完整文档模板目录与创建入口。provider 返回模板,createDocument 决定如何开启独立副本;它与导出样式模板不同。
@quirekit/document-template-library/classic · Commercial
编辑器适用范围
层次:Classic 产品适配
| 编辑器 | 状态 | 所需装配与边界 |
|---|---|---|
| Classic | 直接支持 | 这是 Classic 产品插件,加入 createClassicEditor 的 plugins;依赖的模型、宿主端口和服务必须按下方配置提供。 |
| Block | 未支持 | Block 不消费 Classic 产品 contribution、plugins 或分页装配。请使用共享能力和 Block 适配入口,不能直接复制此入口的 Classic 配置。 |
“直接支持”指已有上述产品装配;具体交互、宿主服务和格式支持仍有各自条件。状态与接入规则。许可独立显示。
接入
当前 @quirekit/document-template-library/classic 的包元数据标为 private。本站使用工作区源码;外部项目需先取得对应分发包,不能把下面的公开导出理解为已经能从公共 npm 安装。
此入口属于商业组件。使用前先取得相应分发与授权;安装命令仅适用于已配置该分发源的项目。
这是产品层接入:将产品插件放入 createClassicEditor 的 plugins,不要放进 Core 的 extensions。必填宿主端口见下面的配置。
import { createClassicDocumentTemplatePlugin } from '@quirekit/document-template-library/classic'
安装时按包声明选择兼容版本,外部可用版本以分发源为准。本站使用工作区 Alpha;许可标签来自入口所属包,使用条件见支持与许可。
按编辑器接入
以下片段沿用已挂载的宿主元素 element,宿主负责容器尺寸与保存;退出页面时调用 instance.destroy()。已有预设装配的能力不要再重复追加;需要宿主端口的入口应先完成下方配置。
Classic · 直接支持
这是 Classic 产品插件,加入 createClassicEditor 的 plugins;依赖的模型、宿主端口和服务必须按下方配置提供。
Block · 未支持
Block 不消费 Classic 产品 contribution、plugins 或分页装配。请使用共享能力和 Block 适配入口,不能直接复制此入口的 Classic 配置。
配置
字段传入创建函数的 options。标为“必填”的端口由宿主提供;undefined 表示未显式配置,下面会说明创建层的回退。
provider
必填模板目录接口,负责列出可用模板并读取精确版本;插件不会自行获取一个远程目录。
类型:DocumentTemplateProvider
默认:必填,宿主提供
createDocument
可选的新文档创建回调,替换默认的备份并打开行为;自定义实现需处理当前文件保留和新会话。
类型:(instance: DocumentTemplateInstance, context: ClassicEditorRenderContext): Promise<void>
默认:undefined
preservationNotice
向用户说明模板内容保全边界的文案或反馈接口。
类型:string
默认:undefined
命令与运行方式
此入口没有直接声明可枚举的命令。组合扩展的命令由子扩展提供;产品插件通过 contribution 或文件服务工作。不能把安装入口名称当作命令调用。
下一步
继续Classic 快速接入和配置与生命周期。开发自己的产品界面与服务时,见产品插件开发。