Files
Tom Moor 179d7dd7be fix: Improve table controls around merged cells (#13897)
* wip

* fix: Position grips in merged cells from the rendered layout

* fix: Only merge row and column selections that cover whole rows or columns

* perf: Find merged cell spans without scanning the table map

* refactor: Extract helpers for cells starting in a row or column
2026-09-27 13:10:43 -04:00

178 lines
4.5 KiB
TypeScript

import { chainCommands } from "prosemirror-commands";
import { InputRule } from "prosemirror-inputrules";
import type { NodeSpec, Node as ProsemirrorNode } from "prosemirror-model";
import { TextSelection } from "prosemirror-state";
import {
columnResizing,
deleteTable,
goToNextCell,
moveTableColumn,
moveTableRow,
tableEditing,
toggleHeader,
} from "prosemirror-tables";
import {
addRowBefore,
addRowAfter,
addColumnBefore,
addColumnAfter,
addRowAndMoveSelection,
setColumnAttr,
setRowAttr,
createTable,
exportTable,
distributeColumns,
sortTable,
setTableAttr,
deleteColSelection,
deleteColumns,
deleteRows,
deleteRowSelection,
deleteCellSelection,
moveOutOfTable,
createTableInner,
deleteTableIfSelected,
splitCellAndCollapse,
mergeCellsAndCollapse,
toggleColumnBackground,
toggleRowBackground,
toggleCellSelectionBackground,
toggleCellSelectionBackgroundAndCollapseSelection,
toggleRowBackgroundAndCollapseSelection,
toggleColumnBackgroundAndCollapseSelection,
} from "../commands/table";
import type { MarkdownSerializerState } from "../lib/markdown/serializer";
import { FixTablesPlugin } from "../plugins/FixTablesPlugin";
import { TableColumnResizePlugin } from "../plugins/TableColumnResizePlugin";
import { TableLayoutPlugin } from "../plugins/TableLayoutPlugin";
import tablesRule from "../rules/tables";
import { EditorStyleHelper } from "../styles/EditorStyleHelper";
import type { TableLayout } from "../types";
import Node from "./Node";
import { TableView } from "./TableView";
export type TableAttrs = {
layout: TableLayout | null;
};
export default class Table extends Node {
get name() {
return "table";
}
get schema(): NodeSpec {
return {
content: "tr+",
tableRole: "table",
isolating: true,
group: "block",
parseDOM: [{ tag: "table" }],
attrs: {
layout: {
default: null,
},
},
toDOM() {
// Note: This is overridden by TableView
return [
"div",
{ class: EditorStyleHelper.table },
["table", {}, ["tbody", 0]],
];
},
};
}
get rulePlugins() {
return [tablesRule];
}
commands() {
return {
createTable,
setColumnAttr,
setRowAttr,
setTableAttr,
sortTable,
addColumnBefore,
addColumnAfter,
deleteColumn: () => deleteColumns(),
addRowBefore,
addRowAfter,
moveTableRow,
moveTableColumn,
deleteRow: () => deleteRows(),
deleteTable: () => deleteTable,
exportTable,
distributeColumns,
toggleHeaderColumn: () => toggleHeader("column"),
toggleHeaderRow: () => toggleHeader("row"),
mergeCells: () => mergeCellsAndCollapse(),
splitCell: () => splitCellAndCollapse(),
toggleRowBackground,
toggleRowBackgroundAndCollapseSelection,
toggleColumnBackground,
toggleColumnBackgroundAndCollapseSelection,
toggleCellSelectionBackground,
toggleCellSelectionBackgroundAndCollapseSelection,
};
}
keys() {
return {
Tab: chainCommands(goToNextCell(1), addRowAndMoveSelection()),
"Shift-Tab": goToNextCell(-1),
"Mod-Enter": addRowAndMoveSelection(),
"Mod-Backspace": chainCommands(
deleteCellSelection,
deleteColSelection(),
deleteRowSelection(),
deleteTableIfSelected()
),
Backspace: chainCommands(
deleteCellSelection,
deleteColSelection(),
deleteRowSelection(),
deleteTableIfSelected()
),
ArrowDown: moveOutOfTable(1),
ArrowUp: moveOutOfTable(-1),
};
}
inputRules() {
return [
new InputRule(/^(\|--)$/, (state, _, start, end) => {
const nodes = createTableInner(state, 2, 2);
const tr = state.tr.replaceWith(start - 1, end, nodes).scrollIntoView();
const resolvedPos = tr.doc.resolve(start + 1);
tr.setSelection(TextSelection.near(resolvedPos));
return tr;
}),
];
}
toMarkdown(state: MarkdownSerializerState, node: ProsemirrorNode) {
state.renderTable(node);
state.closeBlock(node);
}
parseMarkdown() {
return { block: "table" };
}
get plugins() {
return [
// Note: Important to register columnResizing before tableEditing
columnResizing({
View: TableView,
defaultCellMinWidth: 25,
}),
tableEditing(),
new TableColumnResizePlugin(),
new FixTablesPlugin(),
new TableLayoutPlugin(),
];
}
}