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

WordNumbering · 列表与多级编号

用平铺段落上的编号引用表达 Word 列表,集中维护编号定义与级别。不要同时把相同内容再包进通用列表容器。

用平铺段落上的编号引用表达 Word 列表,集中维护编号定义与级别。不要同时把相同内容再包进通用列表容器。

@quirekit/classic-numbering-model · AGPL-3.0-only

编辑器适用范围

层次:共享文档能力

编辑器状态所需装配与边界
Classic直接支持createClassicWordPreset — 使用 createClassicWordPreset 装配 Word 模型、布局与产品适配;具体控件、开关、宿主服务及文件支持以本页说明为准。批注、修订和内容控件的完整创作界面另需 Pro。
Block需适配createBlockNumberingExtensions — 通过 createBlockNumberingExtensions 复用规范编号与命令,并提供连续流标记和 Block 列表控件接缝。只装 WordNumbering 不等于完成 Block 接入。

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

接入

sh

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

ts

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

按编辑器接入

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

Classic · 直接支持

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

createClassicWordPreset
ts

配置

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

types

需要保存平铺编号引用的段落类型名,例如 paragraph。不要填 bulletList 等容器名。

类型:readonly string[]

默认:Object.freeze([ "paragraph", "heading" ])

命令与运行方式

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

命令参数签名
updateWordNumberingDefinitionupdateWordNumberingDefinition(options: UpdateWordNumberingDefinitionOptions)
mergeWordNumberingRegistrymergeWordNumberingRegistry(options: MergeWordNumberingRegistryOptions)
applyWordNumberingPresetapplyWordNumberingPreset(options: ApplyWordNumberingPresetOptions)
applyWordNumberingTemplateapplyWordNumberingTemplate(options: ApplyWordNumberingTemplateOptions)
toggleWordOrderedListtoggleWordOrderedList(options?: ToggleWordOrderedListOptions | undefined)
toggleWordBulletListtoggleWordBulletList()
toggleWordTaskListtoggleWordTaskList(options?: ToggleWordTaskListOptions | undefined)
clearWordListclearWordList()
clearWordListAtPositionclearWordListAtPosition(options: WordNumberingAtPositionOptions)
increaseWordListLevelincreaseWordListLevel()
decreaseWordListLeveldecreaseWordListLevel()
toggleWordTaskCheckedtoggleWordTaskChecked()
setWordTaskCheckedsetWordTaskChecked(options: SetWordTaskCheckedOptions)
toggleWordTaskAtPositiontoggleWordTaskAtPosition(options: ToggleWordTaskAtPositionOptions)
restartWordNumberingrestartWordNumbering(options: RestartWordNumberingOptions)
continueWordNumberingcontinueWordNumbering()
restartWordNumberingAtPositionrestartWordNumberingAtPosition(options: RestartWordNumberingAtPositionOptions)
continueWordNumberingAtPositioncontinueWordNumberingAtPosition(options: WordNumberingAtPositionOptions)

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

需要 DOCX 导入导出与修订留痕时,改用商业包 @quirekit/classic-numbering 中的同名扩展;它包含本扩展的全部能力。

其他公开入口

  • WordNumbering · @quirekit/classic-numbering

下一步

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

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

QuireKitQuireKit · Core、插件与 Classic 文档