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

CommandsExtension · 基础命令

提供 Core 的基础命令集合。Editor 默认安装,通过 enableCoreExtensions 管理;通常不需要手动放入 extensions。

提供 Core 的基础命令集合。Editor 默认安装,通过 enableCoreExtensions 管理;通常不需要手动放入 extensions。

@quirekit/core · MIT

编辑器适用范围

层次:Core 内置能力

编辑器状态所需装配与边界
Classic直接支持由产品创建的 Core 自动安装,通过 Core 的 enableCoreExtensions 和 coreExtensionOptions 管理,不重复追加。视图事件的具体行为仍以当前 View 为准。
Block直接支持由产品创建的 Core 自动安装,通过 Core 的 enableCoreExtensions 和 coreExtensionOptions 管理,不重复追加。视图事件的具体行为仍以当前 View 为准。

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

接入

sh

Editor 默认安装此内置扩展。使用 enableCoreExtensions 控制启用,特定选项放在 coreExtensionOptions;不要再次追加同名扩展。

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

按编辑器接入

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

Classic · 直接支持

由产品创建的 Core 自动安装,通过 Core 的 enableCoreExtensions 和 coreExtensionOptions 管理,不重复追加。视图事件的具体行为仍以当前 View 为准。

配置

此入口没有独立的配置字段。文档属性通过领域命令设置;产品预设可能继续装配其他可配置子扩展。

命令与运行方式

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

命令参数签名
extendMarkRangeextendMarkRange(typeOrName: QuireMarkTypeInput, attributes?: Readonly<Record<string, unknown>>)
resetAttributesresetAttributes(typeOrName: QuireAttributeTypeInput, attributes: string | readonly string[])
setMarksetMark(typeOrName: QuireMarkTypeInput, attrs?: Attrs | null)
setMetasetMeta(key: unknown, value: unknown)
toggleMarktoggleMark(typeOrName: QuireMarkTypeInput, attrs?: Attrs | null, options?: QuireToggleMarkOptions)
unsetAllMarksunsetAllMarks()
unsetMarkunsetMark(typeOrName: QuireMarkTypeInput, options?: QuireUnsetMarkOptions)
updateAttributesupdateAttributes(typeOrName: QuireAttributeTypeInput, attributes?: Readonly<Record<string, unknown>>)
updateDecorationsupdateDecorations(extensionName?: string | undefined)

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

下一步

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

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

QuireKitQuireKit · Core、插件与 Classic 文档