@atlaskit/editor-plugin-table 12.2.6 → 12.3.0

package/src/pm-plugins/commands/delete.ts

@@ -1,42 +0,0 @@
-import type { Command } from '@atlaskit/editor-common/types';
-import type { Rect } from '@atlaskit/editor-tables/table-map';
-
-import type { PluginInjectionAPI } from '../../types';
-import { pluginKey } from '../plugin-key';
-import { deleteColumns } from '../transforms/delete-columns';
-import { getAllowAddColumnCustomStep } from '../utils/get-allow-add-column-custom-step';
-
-export const deleteColumnsCommand =
-	(
-		rect: Rect,
-		api: PluginInjectionAPI | undefined | null,
-		isTableScalingEnabled = false,
-		isTableFixedColumnWidthsOptionEnabled = false,
-		shouldUseIncreasedScalingPercent = false,
-		isCommentEditor = false,
-	): Command =>
-	(state, dispatch, view) => {
-		const tr = deleteColumns(
-			rect,
-			getAllowAddColumnCustomStep(state),
-			api,
-			view,
-			isTableScalingEnabled,
-			isTableFixedColumnWidthsOptionEnabled,
-			shouldUseIncreasedScalingPercent,
-			isCommentEditor,
-		)(state.tr);
-		// If we delete a column we should also clean up the hover selection
-		tr.setMeta(pluginKey, {
-			type: 'CLEAR_HOVER_SELECTION',
-			data: {
-				isInDanger: false,
-				isWholeTableInDanger: false,
-			},
-		});
-		if (dispatch) {
-			dispatch(tr);
-			return true;
-		}
-		return false;
-	};

package/src/pm-plugins/commands/display-mode.ts

@@ -1,18 +0,0 @@
-import type { EditorCommand } from '@atlaskit/editor-common/types';
-import { findTable } from '@atlaskit/editor-tables/utils';
-
-export const setTableDisplayMode: EditorCommand = ({ tr }) => {
-	const table = findTable(tr.selection);
-	if (!table) {
-		return null;
-	}
-
-	const { displayMode } = table.node.attrs;
-
-	tr.setNodeMarkup(table.pos, tr.doc.type.schema.nodes.table, {
-		...table.node.attrs,
-		displayMode: !displayMode || displayMode === 'default' ? 'fixed' : 'default',
-	});
-
-	return tr.setMeta('scrollIntoView', false);
-};

package/src/pm-plugins/commands/go-to-next-cell.ts

@@ -1,198 +0,0 @@
-import type { IntlShape } from 'react-intl-next/src/types';
-
-import { INPUT_METHOD } from '@atlaskit/editor-common/analytics';
-import type { EditorAnalyticsAPI } from '@atlaskit/editor-common/analytics';
-import { isSelectionTableNestedInTable } from '@atlaskit/editor-common/nesting';
-import type { Command } from '@atlaskit/editor-common/types';
-import { type Node as PMNode } from '@atlaskit/editor-prosemirror/model';
-import { NodeSelection, TextSelection } from '@atlaskit/editor-prosemirror/state';
-import { findParentNodeOfType } from '@atlaskit/editor-prosemirror/utils';
-import { TableMap } from '@atlaskit/editor-tables/table-map';
-import type { Direction } from '@atlaskit/editor-tables/types';
-import {
-	goToNextCell as baseGotoNextCell,
-	findCellClosestToPos,
-	findTable,
-	findTableClosestToPos,
-	isTableSelected,
-} from '@atlaskit/editor-tables/utils';
-
-import { getPluginState } from '../plugin-factory';
-
-import { stopKeyboardColumnResizing } from './column-resize';
-import { insertRowWithAnalytics } from './commands-with-analytics';
-
-const TAB_FORWARD_DIRECTION = 1;
-const TAB_BACKWARD_DIRECTION = -1;
-
-export const goToNextCell =
-	(
-		editorAnalyticsAPI: EditorAnalyticsAPI | undefined | null,
-		ariaNotify?: (message: string) => void,
-		getIntl?: () => IntlShape,
-	) =>
-	(direction: Direction): Command =>
-	(state, dispatch, view) => {
-		const table = findTable(state.selection);
-		if (!table) {
-			return false;
-		}
-
-		const isColumnResizing = getPluginState(state)?.isKeyboardResize;
-		if (isColumnResizing) {
-			stopKeyboardColumnResizing({
-				ariaNotify: ariaNotify,
-				getIntl: getIntl,
-			})(state, dispatch, view);
-			return true;
-		}
-
-		const map = TableMap.get(table.node);
-		const { tableCell, tableHeader } = state.schema.nodes;
-		// Ignored via go/ees005
-		// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-		const cell = findParentNodeOfType([tableCell, tableHeader])(state.selection)!;
-		const firstCellPos = map.positionAt(0, 0, table.node) + table.start;
-		const lastCellPos = map.positionAt(map.height - 1, map.width - 1, table.node) + table.start;
-
-		// When tabbing backwards at first cell (top left), insert row at the start of table
-		if (firstCellPos === cell.pos && direction === TAB_BACKWARD_DIRECTION) {
-			insertRowWithAnalytics(editorAnalyticsAPI)(INPUT_METHOD.KEYBOARD, {
-				index: 0,
-				moveCursorToInsertedRow: true,
-			})(state, dispatch);
-			return true;
-		}
-
-		// When tabbing forwards at last cell (bottom right), insert row at the end of table
-		if (lastCellPos === cell.pos && direction === TAB_FORWARD_DIRECTION) {
-			insertRowWithAnalytics(editorAnalyticsAPI)(INPUT_METHOD.KEYBOARD, {
-				index: map.height,
-				moveCursorToInsertedRow: true,
-			})(state, dispatch);
-			return true;
-		}
-
-		if (dispatch) {
-			return baseGotoNextCell(direction)(state, dispatch);
-		}
-
-		return true;
-	};
-
-/**
- * Moves the cursor vertically from a NodeSelection within a table cell.
- * - If content exists above/below within the cell, lets ProseMirror handle it.
- * - Otherwise, moves to the next cell (down to start, up to last line).
- */
-export const goToNextCellVertical =
-	(direction: Direction): Command =>
-	(state, dispatch) => {
-		const { selection } = state;
-		const nestedTableSelection = isSelectionTableNestedInTable(state);
-
-		if (!(selection instanceof NodeSelection) && !nestedTableSelection) {
-			return false; // Let ProseMirror handle other selection types
-		}
-
-		let table = findTable(selection);
-		let cell = findCellClosestToPos(state.doc.resolve(selection.from));
-		let selectionPos = selection.from;
-
-		// Handle when we have nested table fully selected
-		if (table && nestedTableSelection && isTableSelected(selection)) {
-			const parentTablePos = table.pos;
-			table = findTableClosestToPos(state.doc.resolve(parentTablePos));
-			cell = findCellClosestToPos(state.doc.resolve(parentTablePos));
-			selectionPos = parentTablePos;
-		}
-
-		if (!table || !cell || !cell.pos) {
-			return false;
-		}
-
-		const { tableCell, tableHeader } = state.schema.nodes;
-
-		// Let ProseMirror handle movement within the cell if content exists above/below
-		if (cellHasContentInDirection(cell.node, cell.pos, selectionPos, direction)) {
-			return false;
-		}
-
-		// Move to the next cell vertically
-		const map = TableMap.get(table.node);
-		const nextCellPos = map.nextCell(cell.pos - table.start, 'vert', direction);
-		if (dispatch && nextCellPos) {
-			const nextCellStart = table.start + nextCellPos;
-			const $nextCell = state.doc.resolve(nextCellStart);
-
-			if (
-				$nextCell.nodeAfter?.type &&
-				[tableCell, tableHeader].includes($nextCell.nodeAfter?.type)
-			) {
-				const contentPos = getTargetPositionInNextCell(
-					$nextCell.nodeAfter,
-					nextCellStart,
-					direction,
-				);
-
-				dispatch(state.tr.setSelection(TextSelection.create(state.doc, contentPos)));
-				return true;
-			}
-
-			return false;
-		}
-
-		return false; // No next cell found
-	};
-
-function cellHasContentInDirection(
-	cellNode: PMNode,
-	cellPos: number,
-	selectionPos: number,
-	direction: Direction,
-): boolean {
-	let hasContent = false;
-
-	cellNode.content.forEach((node: PMNode, offset: number) => {
-		const nodeStart = cellPos + 1 + offset;
-		const nodeEnd = nodeStart + node.nodeSize;
-
-		if (direction === 1 && nodeStart > selectionPos && node.isBlock) {
-			hasContent = true; // Content below
-		} else if (direction === -1 && nodeEnd <= selectionPos && node.isBlock) {
-			hasContent = true; // Content above
-		}
-	});
-
-	return hasContent;
-}
-
-function getTargetPositionInNextCell(
-	cellNode: PMNode,
-	nextCellStart: number,
-	direction: Direction,
-): number {
-	let contentPos = nextCellStart + 1; // Default: just inside the cell
-	if (cellNode.content.size > 0) {
-		if (direction === 1) {
-			const firstChild = cellNode.firstChild;
-			if (firstChild && firstChild.isBlock) {
-				contentPos = nextCellStart + 1 + (firstChild.isLeaf ? 0 : 1); // Down: Start of first block
-			}
-		} else if (direction === -1) {
-			let lastBlock: PMNode | undefined;
-			let lastOffset = 0;
-			cellNode.content.forEach((node: PMNode, offset: number) => {
-				if (node.isBlock) {
-					lastBlock = node;
-					lastOffset = offset;
-				}
-			});
-			if (lastBlock) {
-				contentPos =
-					nextCellStart + 1 + lastOffset + (lastBlock.isLeaf ? 0 : lastBlock.nodeSize - 1);
-			}
-		}
-	}
-	return contentPos;
-}

package/src/pm-plugins/commands/hover.ts

@@ -1,242 +0,0 @@
-// #region Imports
-import { TableMap } from '@atlaskit/editor-tables/table-map';
-import { findTable, getCellsInColumn, getCellsInRow } from '@atlaskit/editor-tables/utils';
-
-import type { Cell, CellColumnPositioning } from '../../types';
-import { TableDecorations } from '../../types';
-import { createCommand, getPluginState } from '../plugin-factory';
-import {
-	createCellHoverDecoration,
-	createColumnLineResize,
-	createControlsHoverDecoration,
-} from '../utils/decoration';
-import { getMergedCellsPositions } from '../utils/table';
-import { updatePluginStateDecorations } from '../utils/update-plugin-state-decorations';
-
-const makeArray = (n: number) => Array.from(Array(n).keys());
-
-export const hoverMergedCells = () =>
-	createCommand(
-		(state) => {
-			const mergedCellsPositions = getMergedCellsPositions(state.tr);
-			if (!mergedCellsPositions.length) {
-				return false;
-			}
-			const table = findTable(state.tr.selection);
-			if (!table) {
-				return false;
-			}
-
-			const mergedCells: Cell[] = mergedCellsPositions.map((pos) => ({
-				pos: pos + table.start,
-				start: pos + table.start + 1,
-				// Ignored via go/ees005
-				// eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-				node: table.node.nodeAt(pos)!,
-			}));
-
-			const decorations = createCellHoverDecoration(mergedCells);
-
-			return {
-				type: 'HOVER_MERGED_CELLS',
-				data: {
-					decorationSet: updatePluginStateDecorations(
-						state,
-						decorations,
-						TableDecorations.CELL_CONTROLS_HOVER,
-					),
-				},
-			};
-		},
-		(tr) => tr.setMeta('addToHistory', false),
-	);
-
-export const hoverColumns = (hoveredColumns: number[], isInDanger?: boolean) =>
-	createCommand(
-		(state) => {
-			const cells = getCellsInColumn(hoveredColumns)(state.tr.selection);
-
-			const { isDragAndDropEnabled } = getPluginState(state);
-			if (!cells) {
-				return false;
-			}
-
-			const decorations = createControlsHoverDecoration(
-				cells,
-				'column',
-				state.tr,
-				isDragAndDropEnabled,
-				hoveredColumns,
-				isInDanger,
-			);
-
-			return {
-				type: 'HOVER_COLUMNS',
-				data: {
-					decorationSet: updatePluginStateDecorations(
-						state,
-						decorations,
-						TableDecorations.COLUMN_CONTROLS_HOVER,
-					),
-					hoveredColumns,
-					isInDanger,
-				},
-			};
-		},
-		(tr) => tr.setMeta('addToHistory', false),
-	);
-
-export const hoverRows = (hoveredRows: number[], isInDanger?: boolean) =>
-	createCommand(
-		(state) => {
-			const cells = getCellsInRow(hoveredRows)(state.selection);
-			if (!cells) {
-				return false;
-			}
-			const { isDragAndDropEnabled } = getPluginState(state);
-			const decorations = createControlsHoverDecoration(
-				cells,
-				'row',
-				state.tr,
-				isDragAndDropEnabled,
-				hoveredRows,
-				isInDanger,
-			);
-
-			return {
-				type: 'HOVER_ROWS',
-				data: {
-					decorationSet: updatePluginStateDecorations(
-						state,
-						decorations,
-						TableDecorations.ROW_CONTROLS_HOVER,
-					),
-					hoveredRows,
-					isInDanger,
-				},
-			};
-		},
-		(tr) => tr.setMeta('addToHistory', false),
-	);
-
-export const hoverTable = (isInDanger?: boolean, isSelected?: boolean) =>
-	createCommand(
-		(state) => {
-			const table = findTable(state.selection);
-			if (!table) {
-				return false;
-			}
-			const map = TableMap.get(table.node);
-			const hoveredColumns = makeArray(map.width);
-			const hoveredRows = makeArray(map.height);
-			const cells = getCellsInRow(hoveredRows)(state.selection);
-			if (!cells) {
-				return false;
-			}
-			const { isDragAndDropEnabled } = getPluginState(state);
-			const decorations = createControlsHoverDecoration(
-				cells,
-				'table',
-				state.tr,
-				isDragAndDropEnabled,
-				[],
-				isInDanger,
-				isSelected,
-			);
-
-			return {
-				type: 'HOVER_TABLE',
-				data: {
-					decorationSet: updatePluginStateDecorations(
-						state,
-						decorations,
-						TableDecorations.TABLE_CONTROLS_HOVER,
-					),
-					hoveredColumns,
-					hoveredRows,
-					isInDanger,
-					isWholeTableInDanger: isInDanger,
-				},
-			};
-		},
-		(tr) => tr.setMeta('addToHistory', false),
-	);
-
-export const clearHoverSelection = () =>
-	createCommand((state) => ({
-		type: 'CLEAR_HOVER_SELECTION',
-		data: {
-			decorationSet: updatePluginStateDecorations(state, [], TableDecorations.ALL_CONTROLS_HOVER),
-			isInDanger: false,
-			isWholeTableInDanger: false,
-		},
-	}));
-
-export const showResizeHandleLine = (cellColumnPositioning: CellColumnPositioning) =>
-	createCommand((state) => {
-		const { isDragAndDropEnabled } = getPluginState(state);
-
-		return {
-			type: 'SHOW_RESIZE_HANDLE_LINE',
-			data: {
-				decorationSet: updatePluginStateDecorations(
-					state,
-					createColumnLineResize(state.selection, cellColumnPositioning, isDragAndDropEnabled),
-					TableDecorations.COLUMN_RESIZING_HANDLE_LINE,
-				),
-			},
-		};
-	});
-
-export const hideResizeHandleLine = () =>
-	createCommand((state) => ({
-		type: 'HIDE_RESIZE_HANDLE_LINE',
-		data: {
-			decorationSet: updatePluginStateDecorations(
-				state,
-				[],
-				TableDecorations.COLUMN_RESIZING_HANDLE_LINE,
-			),
-		},
-	}));
-
-export const setTableHovered = (hovered: boolean) =>
-	createCommand(
-		() => {
-			return {
-				type: 'TABLE_HOVERED',
-				data: {
-					isTableHovered: hovered,
-				},
-			};
-		},
-		(tr) => tr.setMeta('addToHistory', false),
-	);
-
-export const hoverCell = (rowIndex?: number, colIndex?: number) =>
-	createCommand(
-		(state) => {
-			const { hoveredCell: prevHoveredCell } = getPluginState(state);
-
-			// If no arguments have been passed then the intention it to reset the hover cell data
-			const clear = rowIndex === undefined && colIndex === undefined;
-
-			const nextRowIndex = clear ? undefined : rowIndex ?? prevHoveredCell.rowIndex;
-			const nextColIndex = clear ? undefined : colIndex ?? prevHoveredCell.colIndex;
-
-			if (nextRowIndex === prevHoveredCell.rowIndex && nextColIndex === prevHoveredCell.colIndex) {
-				return false;
-			}
-
-			return {
-				type: 'HOVER_CELL',
-				data: {
-					hoveredCell: {
-						rowIndex: nextRowIndex,
-						colIndex: nextColIndex,
-					},
-				},
-			};
-		},
-		(tr) => tr.setMeta('addToHistory', false),
-	);

package/src/pm-plugins/commands/index.ts

@@ -1,51 +0,0 @@
-/* eslint-disable @atlaskit/editor/no-re-export */
-// Entry file in package.json
-
-export {
-	hoverColumns,
-	hoverRows,
-	hoverTable,
-	hoverCell,
-	hoverMergedCells,
-	clearHoverSelection,
-	showResizeHandleLine,
-	hideResizeHandleLine,
-	setTableHovered,
-} from './hover';
-export { insertColumn, insertRow, createTable } from './insert';
-export {
-	getNextLayout,
-	toggleContextualMenu,
-	toggleHeaderColumn,
-	toggleHeaderRow,
-	toggleNumberColumn,
-	toggleTableLayout,
-} from './toggle';
-export { clearMultipleCells } from './clear';
-export {
-	autoSizeTable,
-	convertFirstRowToHeader,
-	deleteTable,
-	hideInsertColumnOrRowButton,
-	moveCursorBackward,
-	selectColumn,
-	selectColumns,
-	selectRow,
-	selectRows,
-	setCellAttr,
-	setEditorFocus,
-	setMultipleCellAttrs,
-	setTableRef,
-	showInsertColumnButton,
-	showInsertRowButton,
-	transformSliceToAddTableHeaders,
-	triggerUnlessTableHeader,
-	addBoldInEmptyHeaderCells,
-	addResizeHandleDecorations,
-	updateWidthToWidest,
-	setFocusToCellMenu,
-} from './misc';
-export { sortByColumn } from './sort';
-export { goToNextCell } from './go-to-next-cell';
-export { removeDescendantNodes } from './referentiality';
-export { setTableDisplayMode } from './display-mode';