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

WordBlockInteraction · Word 块操作准入

在通用块交互之上约束 Word 的可移动范围与结构完整性。完整 Word 文档应使用此策略处理表格、分节等特殊结构。

在通用块交互之上约束 Word 的可移动范围与结构完整性。完整 Word 文档应使用此策略处理表格、分节等特殊结构。

@quirekit/classic-block-interaction · Commercial

编辑器适用范围

层次:共享文档能力

编辑器状态所需装配与边界
Classic直接支持createClassicWordPreset — 使用 createClassicWordPreset 装配 Word 模型、布局与产品适配;具体控件、开关、宿主服务及文件支持以本页说明为准。批注、修订和内容控件的完整创作界面另需 Pro。
Block未验证尚未建立此入口的完整产品接入与验证路径。公开 Core 导出不代表当前产品已提供对应呈现、控件或文件支持。

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

接入

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

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

Word 产品通常从 Word 预设开始。这里的公开符号用于独立 Core 或自定义预设;需按领域补齐配套节点、命令和布局,已有同名扩展时不能重复追加。

ts

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

按编辑器接入

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

Classic · 直接支持

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

createClassicWordPreset
ts

配置

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

types

需要附加此能力的节点或标记类型名,必须与当前 schema 的实际名称一致。

类型:readonly string[]

默认:见下方默认值

ts

scopes

可容纳块操作的结构范围类型,例如 doc。

类型:readonly string[]

默认:["wordSection"]

createId

为新块生成稳定身份的函数。复制与拆分仍需遵循块身份规则。

类型:(): string

默认:createBlockId

admit

块移动或插入前的准入函数,拒绝会破坏结构或业务规则的操作。

类型:(context: BlockAdmissionContext): BlockRejection | null

默认:admitWordBlockOperation

requirePortableIdentity

是否要求参与操作的块具备可持久化的稳定身份。

类型:boolean

默认:false

命令与运行方式

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

命令参数签名
selectBlockRangeselectBlockRange(range: BlockRangeRef | null)
moveBlockRangemoveBlockRange(request: BlockMoveRequest)
insertBlockAtinsertBlockAt(request: BlockInsertRequest)

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

下一步

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

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

QuireKitQuireKit · Core、插件与 Classic 文档