定义 Word 表格节点及对应领域命令。表格行、单元格、布局和交互需要成套装配,通常直接使用 Word 预设。
@quirekit/classic-table-model · AGPL-3.0-only
编辑器适用范围
层次:共享文档能力
| 编辑器 | 状态 | 所需装配与边界 |
|---|---|---|
| Classic | 直接支持 | createClassicWordPreset — 使用 createClassicWordPreset 装配 Word 模型、布局与产品适配;具体控件、开关、宿主服务及文件支持以本页说明为准。批注、修订和内容控件的完整创作界面另需 Pro。 |
| Block | 需适配 | createBlockTableExtensions — 通过 createBlockTableExtensions 装配表格节点和 table-only profile。表格菜单还需将 @quirekit/block-table/vue 的 BlockTableMenu 接入 BlockEditor 的 tools 插槽;不包含分页、分节或页眉页脚。 |
“直接支持”指已有上述产品装配;具体交互、宿主服务和格式支持仍有各自条件。状态与接入规则。许可独立显示。
接入
pnpm add @quirekit/classic-table-model@alpha
Word 产品通常从 Word 预设开始。这里的公开符号用于独立 Core 或自定义预设;需按领域补齐配套节点、命令和布局,已有同名扩展时不能重复追加。
import { WordTable } from '@quirekit/classic-table-model'
安装时按包声明选择兼容版本,外部可用版本以分发源为准。本站使用工作区 Alpha;许可标签来自入口所属包,使用条件见支持与许可。
按编辑器接入
以下片段沿用已挂载的宿主元素 element,宿主负责容器尺寸与保存;退出页面时调用 instance.destroy()。已有预设装配的能力不要再重复追加;需要宿主端口的入口应先完成下方配置。
Classic · 直接支持
使用 createClassicWordPreset 装配 Word 模型、布局与产品适配;具体控件、开关、宿主服务及文件支持以本页说明为准。批注、修订和内容控件的完整创作界面另需 Pro。
createClassicWordPresetimport { createClassicEditor } from '@quirekit/classic-editor'
import '@quirekit/classic-editor/styles.css'
import { createClassicWordDefaultDocument, createClassicWordPreset } from '@quirekit/classic-docx'
import '@quirekit/classic-docx/styles.css'
const instance = createClassicEditor({
element,
preset: createClassicWordPreset(),
document: createClassicWordDefaultDocument(),
})Block · 需适配
通过 createBlockTableExtensions 装配表格节点和 table-only profile。表格菜单还需将 @quirekit/block-table/vue 的 BlockTableMenu 接入 BlockEditor 的 tools 插槽;不包含分页、分节或页眉页脚。
createBlockTableExtensionsimport { createBlockEditor } from '@quirekit/block-editor'
import '@quirekit/block-editor/styles.css'
import { createBlockTableExtensions } from '@quirekit/block-table'
const instance = createBlockEditor({
element,
extensions: [...createBlockTableExtensions()],
content: { type: 'doc', content: [{ type: 'paragraph' }] },
})配置
此入口没有独立的配置字段。文档属性通过领域命令设置;产品预设可能继续装配其他可配置子扩展。
命令与运行方式
以下命令由此扩展直接提供,均在当前 Editor 上调用。命令是否可用由已安装 schema、当前选区与保护策略决定;可以先用 editor.can() 查询。
| 命令 | 参数签名 |
|---|---|
addWordTableRow | addWordTableRow(options: AddWordTableRowCommandOptions) |
addWordTableRows | addWordTableRows(options: AddWordTableRowsCommandOptions) |
addWordTableColumns | addWordTableColumns(options: AddWordTableColumnsCommandOptions) |
deleteWordTableRows | deleteWordTableRows(options?: SelectionBackedCommandOptions<DeleteWordTableRowsCommandOptions, "from" | "to"> | undefined) |
addWordTableColumn | addWordTableColumn(options: AddWordTableColumnCommandOptions) |
deleteWordTableColumns | deleteWordTableColumns(options?: SelectionBackedCommandOptions<DeleteWordTableColumnsCommandOptions, "from" | "to"> | undefined) |
mergeWordTableCells | mergeWordTableCells(options?: SelectionBackedCommandOptions<MergeWordTableCellsCommandOptions, TableRectCoordinate> | undefined) |
splitWordTableCell | splitWordTableCell(options?: SelectionBackedCommandOptions<SplitWordTableCellCommandOptions, "rowIndex" | "columnIndex"> | undefined) |
setWordTableAttrs | setWordTableAttrs(options: SetWordTableAttrsCommandOptions) |
setWordTableColumnWidth | setWordTableColumnWidth(options: SetWordTableColumnWidthCommandOptions) |
setWordTableRowHeight | setWordTableRowHeight(options: SetWordTableRowHeightCommandOptions) |
distributeWordTableColumns | distributeWordTableColumns(options?: SelectionBackedCommandOptions<DistributeWordTableColumnsCommandOptions, "from" | "to"> | undefined) |
distributeWordTableRows | distributeWordTableRows(options?: SelectionBackedCommandOptions<DistributeWordTableRowsCommandOptions, "from" | "to"> | undefined) |
setWordTableCellMargin | setWordTableCellMargin(options: SelectionBackedCommandOptions<SetWordTableCellMarginCommandOptions, TableRectCoordinate>) |
setWordTableCellAttrs | setWordTableCellAttrs(options: SelectionBackedCommandOptions<SetWordTableCellAttrsCommandOptions, TableRectCoordinate>) |
setWordTableRowAttrs | setWordTableRowAttrs(options: SetWordTableRowAttrsCommandOptions) |
setWordTableCellBorders | setWordTableCellBorders(options: SelectionBackedCommandOptions<SetWordTableCellBordersCommandOptions, TableRectCoordinate>) |
setWordTableCellBorderFormat | setWordTableCellBorderFormat(options: SelectionBackedCommandOptions<SetWordTableCellBorderFormatCommandOptions, TableRectCoordinate>) |
clearWordTableCellFormatting | clearWordTableCellFormatting(options?: SelectionBackedCommandOptions<ClearWordTableCellFormattingCommandOptions, TableRectCoordinate> | undefined) |
这里只展示参数签名。接界面时见命令与控件,正文变更继续经过同一事务与历史。
需要 DOCX 导入导出与修订留痕时,改用商业包 @quirekit/classic-table 中的同名扩展;它包含本扩展的全部能力。
其他公开入口
WordTable·@quirekit/classic-table