@ckeditor/ckeditor5-table 39.0.2 → 40.0.0

package/src/commands/mergecellscommand.js

@@ -1,94 +1,94 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import { Command } from 'ckeditor5/src/core';
-import TableUtils from '../tableutils';
-import { updateNumericAttribute } from '../utils/common';
-import { removeEmptyRowsColumns } from '../utils/structure';
-/**
- * The merge cells command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'mergeTableCells'` editor command.
- *
- * For example, to merge selected table cells:
- *
- * ```ts
- * editor.execute( 'mergeTableCells' );
- * ```
- */
-export default class MergeCellsCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const tableUtils = this.editor.plugins.get(TableUtils);
-        const selectedTableCells = tableUtils.getSelectedTableCells(this.editor.model.document.selection);
-        this.isEnabled = tableUtils.isSelectionRectangular(selectedTableCells);
-    }
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     */
-    execute() {
-        const model = this.editor.model;
-        const tableUtils = this.editor.plugins.get(TableUtils);
-        model.change(writer => {
-            const selectedTableCells = tableUtils.getSelectedTableCells(model.document.selection);
-            // All cells will be merged into the first one.
-            const firstTableCell = selectedTableCells.shift();
-            // Update target cell dimensions.
-            const { mergeWidth, mergeHeight } = getMergeDimensions(firstTableCell, selectedTableCells, tableUtils);
-            updateNumericAttribute('colspan', mergeWidth, firstTableCell, writer);
-            updateNumericAttribute('rowspan', mergeHeight, firstTableCell, writer);
-            for (const tableCell of selectedTableCells) {
-                mergeTableCells(tableCell, firstTableCell, writer);
-            }
-            const table = firstTableCell.findAncestor('table');
-            // Remove rows and columns that become empty (have no anchored cells).
-            removeEmptyRowsColumns(table, tableUtils);
-            writer.setSelection(firstTableCell, 'in');
-        });
-    }
-}
-/**
- *  Merges two table cells. It will ensure that after merging cells with empty paragraphs the resulting table cell will only have one
- * paragraph. If one of the merged table cells is empty, the merged table cell will have contents of the non-empty table cell.
- * If both are empty, the merged table cell will have only one empty paragraph.
- */
-function mergeTableCells(cellBeingMerged, targetCell, writer) {
-    if (!isEmpty(cellBeingMerged)) {
-        if (isEmpty(targetCell)) {
-            writer.remove(writer.createRangeIn(targetCell));
-        }
-        writer.move(writer.createRangeIn(cellBeingMerged), writer.createPositionAt(targetCell, 'end'));
-    }
-    // Remove merged table cell.
-    writer.remove(cellBeingMerged);
-}
-/**
- * Checks if the passed table cell contains an empty paragraph.
- */
-function isEmpty(tableCell) {
-    const firstTableChild = tableCell.getChild(0);
-    return tableCell.childCount == 1 && firstTableChild.is('element', 'paragraph') && firstTableChild.isEmpty;
-}
-function getMergeDimensions(firstTableCell, selectedTableCells, tableUtils) {
-    let maxWidthOffset = 0;
-    let maxHeightOffset = 0;
-    for (const tableCell of selectedTableCells) {
-        const { row, column } = tableUtils.getCellLocation(tableCell);
-        maxWidthOffset = getMaxOffset(tableCell, column, maxWidthOffset, 'colspan');
-        maxHeightOffset = getMaxOffset(tableCell, row, maxHeightOffset, 'rowspan');
-    }
-    // Update table cell span attribute and merge set selection on a merged contents.
-    const { row: firstCellRow, column: firstCellColumn } = tableUtils.getCellLocation(firstTableCell);
-    const mergeWidth = maxWidthOffset - firstCellColumn;
-    const mergeHeight = maxHeightOffset - firstCellRow;
-    return { mergeWidth, mergeHeight };
-}
-function getMaxOffset(tableCell, start, currentMaxOffset, which) {
-    const dimensionValue = parseInt(tableCell.getAttribute(which) || '1');
-    return Math.max(currentMaxOffset, start + dimensionValue);
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Command } from 'ckeditor5/src/core';
+import TableUtils from '../tableutils';
+import { updateNumericAttribute } from '../utils/common';
+import { removeEmptyRowsColumns } from '../utils/structure';
+/**
+ * The merge cells command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'mergeTableCells'` editor command.
+ *
+ * For example, to merge selected table cells:
+ *
+ * ```ts
+ * editor.execute( 'mergeTableCells' );
+ * ```
+ */
+export default class MergeCellsCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const tableUtils = this.editor.plugins.get(TableUtils);
+        const selectedTableCells = tableUtils.getSelectedTableCells(this.editor.model.document.selection);
+        this.isEnabled = tableUtils.isSelectionRectangular(selectedTableCells);
+    }
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     */
+    execute() {
+        const model = this.editor.model;
+        const tableUtils = this.editor.plugins.get(TableUtils);
+        model.change(writer => {
+            const selectedTableCells = tableUtils.getSelectedTableCells(model.document.selection);
+            // All cells will be merged into the first one.
+            const firstTableCell = selectedTableCells.shift();
+            // Update target cell dimensions.
+            const { mergeWidth, mergeHeight } = getMergeDimensions(firstTableCell, selectedTableCells, tableUtils);
+            updateNumericAttribute('colspan', mergeWidth, firstTableCell, writer);
+            updateNumericAttribute('rowspan', mergeHeight, firstTableCell, writer);
+            for (const tableCell of selectedTableCells) {
+                mergeTableCells(tableCell, firstTableCell, writer);
+            }
+            const table = firstTableCell.findAncestor('table');
+            // Remove rows and columns that become empty (have no anchored cells).
+            removeEmptyRowsColumns(table, tableUtils);
+            writer.setSelection(firstTableCell, 'in');
+        });
+    }
+}
+/**
+ *  Merges two table cells. It will ensure that after merging cells with empty paragraphs the resulting table cell will only have one
+ * paragraph. If one of the merged table cells is empty, the merged table cell will have contents of the non-empty table cell.
+ * If both are empty, the merged table cell will have only one empty paragraph.
+ */
+function mergeTableCells(cellBeingMerged, targetCell, writer) {
+    if (!isEmpty(cellBeingMerged)) {
+        if (isEmpty(targetCell)) {
+            writer.remove(writer.createRangeIn(targetCell));
+        }
+        writer.move(writer.createRangeIn(cellBeingMerged), writer.createPositionAt(targetCell, 'end'));
+    }
+    // Remove merged table cell.
+    writer.remove(cellBeingMerged);
+}
+/**
+ * Checks if the passed table cell contains an empty paragraph.
+ */
+function isEmpty(tableCell) {
+    const firstTableChild = tableCell.getChild(0);
+    return tableCell.childCount == 1 && firstTableChild.is('element', 'paragraph') && firstTableChild.isEmpty;
+}
+function getMergeDimensions(firstTableCell, selectedTableCells, tableUtils) {
+    let maxWidthOffset = 0;
+    let maxHeightOffset = 0;
+    for (const tableCell of selectedTableCells) {
+        const { row, column } = tableUtils.getCellLocation(tableCell);
+        maxWidthOffset = getMaxOffset(tableCell, column, maxWidthOffset, 'colspan');
+        maxHeightOffset = getMaxOffset(tableCell, row, maxHeightOffset, 'rowspan');
+    }
+    // Update table cell span attribute and merge set selection on a merged contents.
+    const { row: firstCellRow, column: firstCellColumn } = tableUtils.getCellLocation(firstTableCell);
+    const mergeWidth = maxWidthOffset - firstCellColumn;
+    const mergeHeight = maxHeightOffset - firstCellRow;
+    return { mergeWidth, mergeHeight };
+}
+function getMaxOffset(tableCell, start, currentMaxOffset, which) {
+    const dimensionValue = parseInt(tableCell.getAttribute(which) || '1');
+    return Math.max(currentMaxOffset, start + dimensionValue);
+}

package/src/commands/removecolumncommand.d.ts

@@ -1,29 +1,29 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module table/commands/removecolumncommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The remove column command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'removeTableColumn'` editor command.
- *
- * To remove the column containing the selected cell, execute the command:
- *
- * ```ts
- * editor.execute( 'removeTableColumn' );
- * ```
- */
-export default class RemoveColumnCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * @inheritDoc
-     */
-    execute(): void;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module table/commands/removecolumncommand
+ */
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The remove column command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'removeTableColumn'` editor command.
+ *
+ * To remove the column containing the selected cell, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'removeTableColumn' );
+ * ```
+ */
+export default class RemoveColumnCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * @inheritDoc
+     */
+    execute(): void;
+}

package/src/commands/removecolumncommand.js

@@ -1,109 +1,109 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module table/commands/removecolumncommand
- */
-import { Command } from 'ckeditor5/src/core';
-import TableWalker from '../tablewalker';
-/**
- * The remove column command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'removeTableColumn'` editor command.
- *
- * To remove the column containing the selected cell, execute the command:
- *
- * ```ts
- * editor.execute( 'removeTableColumn' );
- * ```
- */
-export default class RemoveColumnCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const selectedCells = tableUtils.getSelectionAffectedTableCells(this.editor.model.document.selection);
-        const firstCell = selectedCells[0];
-        if (firstCell) {
-            const table = firstCell.findAncestor('table');
-            const tableColumnCount = tableUtils.getColumns(table);
-            const { first, last } = tableUtils.getColumnIndexes(selectedCells);
-            this.isEnabled = last - first < (tableColumnCount - 1);
-        }
-        else {
-            this.isEnabled = false;
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    execute() {
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const [firstCell, lastCell] = getBoundaryCells(this.editor.model.document.selection, tableUtils);
-        const table = firstCell.parent.parent;
-        // Cache the table before removing or updating colspans.
-        const tableMap = [...new TableWalker(table)];
-        // Store column indexes of removed columns.
-        const removedColumnIndexes = {
-            first: tableMap.find(value => value.cell === firstCell).column,
-            last: tableMap.find(value => value.cell === lastCell).column
-        };
-        const cellToFocus = getCellToFocus(tableMap, firstCell, lastCell, removedColumnIndexes);
-        this.editor.model.change(writer => {
-            const columnsToRemove = removedColumnIndexes.last - removedColumnIndexes.first + 1;
-            tableUtils.removeColumns(table, {
-                at: removedColumnIndexes.first,
-                columns: columnsToRemove
-            });
-            writer.setSelection(writer.createPositionAt(cellToFocus, 0));
-        });
-    }
-}
-/**
- * Returns a proper table cell to focus after removing a column.
- * - selection is on last table cell it will return previous cell.
- */
-function getCellToFocus(tableMap, firstCell, lastCell, removedColumnIndexes) {
-    const colspan = parseInt(lastCell.getAttribute('colspan') || '1');
-    // If the table cell is spanned over 2+ columns - it will be truncated so the selection should
-    // stay in that cell.
-    if (colspan > 1) {
-        return lastCell;
-    }
-    // Normally, look for the cell in the same row that precedes the first cell to put selection there ("column on the left").
-    // If the deleted column is the first column of the table, there will be no predecessor: use the cell
-    // from the column that follows then (also in the same row).
-    else if (firstCell.previousSibling || lastCell.nextSibling) {
-        return lastCell.nextSibling || firstCell.previousSibling;
-    }
-    // It can happen that table cells have no siblings in a row, for instance, when there are row spans
-    // in the table (in the previous row). Then just look for the closest cell that is in a column
-    // that will not be removed to put the selection there.
-    else {
-        // Look for any cell in a column that precedes the first removed column.
-        if (removedColumnIndexes.first) {
-            return tableMap.reverse().find(({ column }) => {
-                return column < removedColumnIndexes.first;
-            }).cell;
-        }
-        // If the first removed column is the first column of the table, then
-        // look for any cell that is in a column that follows the last removed column.
-        else {
-            return tableMap.reverse().find(({ column }) => {
-                return column > removedColumnIndexes.last;
-            }).cell;
-        }
-    }
-}
-/**
- * Returns helper object returning the first and the last cell contained in given selection, based on DOM order.
- */
-function getBoundaryCells(selection, tableUtils) {
-    const referenceCells = tableUtils.getSelectionAffectedTableCells(selection);
-    const firstCell = referenceCells[0];
-    const lastCell = referenceCells.pop();
-    const returnValue = [firstCell, lastCell];
-    return firstCell.isBefore(lastCell) ? returnValue : returnValue.reverse();
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module table/commands/removecolumncommand
+ */
+import { Command } from 'ckeditor5/src/core';
+import TableWalker from '../tablewalker';
+/**
+ * The remove column command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'removeTableColumn'` editor command.
+ *
+ * To remove the column containing the selected cell, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'removeTableColumn' );
+ * ```
+ */
+export default class RemoveColumnCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const tableUtils = this.editor.plugins.get('TableUtils');
+        const selectedCells = tableUtils.getSelectionAffectedTableCells(this.editor.model.document.selection);
+        const firstCell = selectedCells[0];
+        if (firstCell) {
+            const table = firstCell.findAncestor('table');
+            const tableColumnCount = tableUtils.getColumns(table);
+            const { first, last } = tableUtils.getColumnIndexes(selectedCells);
+            this.isEnabled = last - first < (tableColumnCount - 1);
+        }
+        else {
+            this.isEnabled = false;
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    execute() {
+        const tableUtils = this.editor.plugins.get('TableUtils');
+        const [firstCell, lastCell] = getBoundaryCells(this.editor.model.document.selection, tableUtils);
+        const table = firstCell.parent.parent;
+        // Cache the table before removing or updating colspans.
+        const tableMap = [...new TableWalker(table)];
+        // Store column indexes of removed columns.
+        const removedColumnIndexes = {
+            first: tableMap.find(value => value.cell === firstCell).column,
+            last: tableMap.find(value => value.cell === lastCell).column
+        };
+        const cellToFocus = getCellToFocus(tableMap, firstCell, lastCell, removedColumnIndexes);
+        this.editor.model.change(writer => {
+            const columnsToRemove = removedColumnIndexes.last - removedColumnIndexes.first + 1;
+            tableUtils.removeColumns(table, {
+                at: removedColumnIndexes.first,
+                columns: columnsToRemove
+            });
+            writer.setSelection(writer.createPositionAt(cellToFocus, 0));
+        });
+    }
+}
+/**
+ * Returns a proper table cell to focus after removing a column.
+ * - selection is on last table cell it will return previous cell.
+ */
+function getCellToFocus(tableMap, firstCell, lastCell, removedColumnIndexes) {
+    const colspan = parseInt(lastCell.getAttribute('colspan') || '1');
+    // If the table cell is spanned over 2+ columns - it will be truncated so the selection should
+    // stay in that cell.
+    if (colspan > 1) {
+        return lastCell;
+    }
+    // Normally, look for the cell in the same row that precedes the first cell to put selection there ("column on the left").
+    // If the deleted column is the first column of the table, there will be no predecessor: use the cell
+    // from the column that follows then (also in the same row).
+    else if (firstCell.previousSibling || lastCell.nextSibling) {
+        return lastCell.nextSibling || firstCell.previousSibling;
+    }
+    // It can happen that table cells have no siblings in a row, for instance, when there are row spans
+    // in the table (in the previous row). Then just look for the closest cell that is in a column
+    // that will not be removed to put the selection there.
+    else {
+        // Look for any cell in a column that precedes the first removed column.
+        if (removedColumnIndexes.first) {
+            return tableMap.reverse().find(({ column }) => {
+                return column < removedColumnIndexes.first;
+            }).cell;
+        }
+        // If the first removed column is the first column of the table, then
+        // look for any cell that is in a column that follows the last removed column.
+        else {
+            return tableMap.reverse().find(({ column }) => {
+                return column > removedColumnIndexes.last;
+            }).cell;
+        }
+    }
+}
+/**
+ * Returns helper object returning the first and the last cell contained in given selection, based on DOM order.
+ */
+function getBoundaryCells(selection, tableUtils) {
+    const referenceCells = tableUtils.getSelectionAffectedTableCells(selection);
+    const firstCell = referenceCells[0];
+    const lastCell = referenceCells.pop();
+    const returnValue = [firstCell, lastCell];
+    return firstCell.isBefore(lastCell) ? returnValue : returnValue.reverse();
+}

package/src/commands/removerowcommand.d.ts

@@ -1,29 +1,29 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module table/commands/removerowcommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The remove row command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'removeTableRow'` editor command.
- *
- * To remove the row containing the selected cell, execute the command:
- *
- * ```ts
- * editor.execute( 'removeTableRow' );
- * ```
- */
-export default class RemoveRowCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * @inheritDoc
-     */
-    execute(): void;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module table/commands/removerowcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The remove row command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'removeTableRow'` editor command.
+ *
+ * To remove the row containing the selected cell, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'removeTableRow' );
+ * ```
+ */
+export default class RemoveRowCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * @inheritDoc
+     */
+    execute(): void;
+}