跳到正文
QuireKit
插件文档
Alpha · API 持续演进
协作与无障碍查看 Markdown ↗

CollaborationSteps · 步骤协作

把 Core 挂到按版本排序的步骤协作绑定。bind 由宿主创建并负责连接与恢复;ready 控制在绑定就绪前的编辑门禁。

把 Core 挂到按版本排序的步骤协作绑定。bind 由宿主创建并负责连接与恢复;ready 控制在绑定就绪前的编辑门禁。

@quirekit/collab-steps/core · AGPL-3.0-only

编辑器适用范围

层次:共享文档能力

编辑器状态所需装配与边界
Classic需适配需由宿主连接本页所列服务、目标与生命周期,并验证所选 View 和文档模型。核心接口可复用,但没有一段无宿主参数的通用产品安装代码。
Block需适配需由宿主连接本页所列服务、目标与生命周期,并验证所选 View 和文档模型。核心接口可复用,但没有一段无宿主参数的通用产品安装代码。

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

接入

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

在创建 Editor 时放入 extensions。挂载容器、视图和保存由宿主提供,见快速开始。

ts

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

按编辑器接入

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

Classic · 需适配

需由宿主连接本页所列服务、目标与生命周期,并验证所选 View 和文档模型。核心接口可复用,但没有一段无宿主参数的通用产品安装代码。

配置

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

bind

为当前编辑器建立步骤协作绑定的宿主函数。

类型:((editor: QuireEditor) => StepBindingOptions) | null

默认:null

ready

步骤绑定是否已就绪,或负责表达就绪状态的宿主接口。

类型:((binding: StepEditorBinding) => void) | null

默认:null

命令与运行方式

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

命令参数签名
applyCollaborationStepsapplyCollaborationSteps(projection: Transform)
undoundo()
redoredo()

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

下一步

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

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

QuireKitQuireKit · Core、插件与 Classic 文档