@ckeditor/ckeditor5-table 39.0.2 → 40.0.0

package/src/commands/removerowcommand.js

@@ -1,82 +1,82 @@
-/**
- * @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() {
-        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 tableRowCount = tableUtils.getRows(table);
-            const lastRowIndex = tableRowCount - 1;
-            const selectedRowIndexes = tableUtils.getRowIndexes(selectedCells);
-            const areAllRowsSelected = selectedRowIndexes.first === 0 && selectedRowIndexes.last === lastRowIndex;
-            // Disallow selecting whole table -> delete whole table should be used instead.
-            this.isEnabled = !areAllRowsSelected;
-        }
-        else {
-            this.isEnabled = false;
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    execute() {
-        const model = this.editor.model;
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const referenceCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
-        const removedRowIndexes = tableUtils.getRowIndexes(referenceCells);
-        const firstCell = referenceCells[0];
-        const table = firstCell.findAncestor('table');
-        const columnIndexToFocus = tableUtils.getCellLocation(firstCell).column;
-        model.change(writer => {
-            const rowsToRemove = removedRowIndexes.last - removedRowIndexes.first + 1;
-            tableUtils.removeRows(table, {
-                at: removedRowIndexes.first,
-                rows: rowsToRemove
-            });
-            const cellToFocus = getCellToFocus(table, removedRowIndexes.first, columnIndexToFocus, tableUtils.getRows(table));
-            writer.setSelection(writer.createPositionAt(cellToFocus, 0));
-        });
-    }
-}
-/**
- * Returns a cell that should be focused before removing the row, belonging to the same column as the currently focused cell.
- * - If the row was not the last one, the cell to focus will be in the row that followed it (before removal).
- * - If the row was the last one, the cell to focus will be in the row that preceded it (before removal).
- */
-function getCellToFocus(table, removedRowIndex, columnToFocus, tableRowCount) {
-    // Don't go beyond last row's index.
-    const row = table.getChild(Math.min(removedRowIndex, tableRowCount - 1));
-    // Default to first table cell.
-    let cellToFocus = row.getChild(0);
-    let column = 0;
-    for (const tableCell of row.getChildren()) {
-        if (column > columnToFocus) {
-            return cellToFocus;
-        }
-        cellToFocus = tableCell;
-        column += parseInt(tableCell.getAttribute('colspan') || '1');
-    }
-    return cellToFocus;
-}
+/**
+ * @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() {
+        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 tableRowCount = tableUtils.getRows(table);
+            const lastRowIndex = tableRowCount - 1;
+            const selectedRowIndexes = tableUtils.getRowIndexes(selectedCells);
+            const areAllRowsSelected = selectedRowIndexes.first === 0 && selectedRowIndexes.last === lastRowIndex;
+            // Disallow selecting whole table -> delete whole table should be used instead.
+            this.isEnabled = !areAllRowsSelected;
+        }
+        else {
+            this.isEnabled = false;
+        }
+    }
+    /**
+     * @inheritDoc
+     */
+    execute() {
+        const model = this.editor.model;
+        const tableUtils = this.editor.plugins.get('TableUtils');
+        const referenceCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
+        const removedRowIndexes = tableUtils.getRowIndexes(referenceCells);
+        const firstCell = referenceCells[0];
+        const table = firstCell.findAncestor('table');
+        const columnIndexToFocus = tableUtils.getCellLocation(firstCell).column;
+        model.change(writer => {
+            const rowsToRemove = removedRowIndexes.last - removedRowIndexes.first + 1;
+            tableUtils.removeRows(table, {
+                at: removedRowIndexes.first,
+                rows: rowsToRemove
+            });
+            const cellToFocus = getCellToFocus(table, removedRowIndexes.first, columnIndexToFocus, tableUtils.getRows(table));
+            writer.setSelection(writer.createPositionAt(cellToFocus, 0));
+        });
+    }
+}
+/**
+ * Returns a cell that should be focused before removing the row, belonging to the same column as the currently focused cell.
+ * - If the row was not the last one, the cell to focus will be in the row that followed it (before removal).
+ * - If the row was the last one, the cell to focus will be in the row that preceded it (before removal).
+ */
+function getCellToFocus(table, removedRowIndex, columnToFocus, tableRowCount) {
+    // Don't go beyond last row's index.
+    const row = table.getChild(Math.min(removedRowIndex, tableRowCount - 1));
+    // Default to first table cell.
+    let cellToFocus = row.getChild(0);
+    let column = 0;
+    for (const tableCell of row.getChildren()) {
+        if (column > columnToFocus) {
+            return cellToFocus;
+        }
+        cellToFocus = tableCell;
+        column += parseInt(tableCell.getAttribute('colspan') || '1');
+    }
+    return cellToFocus;
+}

package/src/commands/selectcolumncommand.d.ts

@@ -1,33 +1,33 @@
-/**
- * @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/selectcolumncommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core';
-/**
- * The select column command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'selectTableColumn'` editor command.
- *
- * To select the columns containing the selected cells, execute the command:
- *
- * ```ts
- * editor.execute( 'selectTableColumn' );
- * ```
- */
-export default class SelectColumnCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @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/selectcolumncommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core';
+/**
+ * The select column command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'selectTableColumn'` editor command.
+ *
+ * To select the columns containing the selected cells, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'selectTableColumn' );
+ * ```
+ */
+export default class SelectColumnCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * @inheritDoc
+     */
+    execute(): void;
+}

package/src/commands/selectcolumncommand.js

@@ -1,60 +1,60 @@
-/**
- * @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/selectcolumncommand
- */
-import { Command } from 'ckeditor5/src/core';
-import TableWalker from '../tablewalker';
-/**
- * The select column command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'selectTableColumn'` editor command.
- *
- * To select the columns containing the selected cells, execute the command:
- *
- * ```ts
- * editor.execute( 'selectTableColumn' );
- * ```
- */
-export default class SelectColumnCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        // It does not affect data so should be enabled in read-only mode.
-        this.affectsData = false;
-    }
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const selectedCells = tableUtils.getSelectionAffectedTableCells(this.editor.model.document.selection);
-        this.isEnabled = selectedCells.length > 0;
-    }
-    /**
-     * @inheritDoc
-     */
-    execute() {
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const model = this.editor.model;
-        const referenceCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
-        const firstCell = referenceCells[0];
-        const lastCell = referenceCells.pop();
-        const table = firstCell.findAncestor('table');
-        const startLocation = tableUtils.getCellLocation(firstCell);
-        const endLocation = tableUtils.getCellLocation(lastCell);
-        const startColumn = Math.min(startLocation.column, endLocation.column);
-        const endColumn = Math.max(startLocation.column, endLocation.column);
-        const rangesToSelect = [];
-        for (const cellInfo of new TableWalker(table, { startColumn, endColumn })) {
-            rangesToSelect.push(model.createRangeOn(cellInfo.cell));
-        }
-        model.change(writer => {
-            writer.setSelection(rangesToSelect);
-        });
-    }
-}
+/**
+ * @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/selectcolumncommand
+ */
+import { Command } from 'ckeditor5/src/core';
+import TableWalker from '../tablewalker';
+/**
+ * The select column command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'selectTableColumn'` editor command.
+ *
+ * To select the columns containing the selected cells, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'selectTableColumn' );
+ * ```
+ */
+export default class SelectColumnCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        // It does not affect data so should be enabled in read-only mode.
+        this.affectsData = false;
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const tableUtils = this.editor.plugins.get('TableUtils');
+        const selectedCells = tableUtils.getSelectionAffectedTableCells(this.editor.model.document.selection);
+        this.isEnabled = selectedCells.length > 0;
+    }
+    /**
+     * @inheritDoc
+     */
+    execute() {
+        const tableUtils = this.editor.plugins.get('TableUtils');
+        const model = this.editor.model;
+        const referenceCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
+        const firstCell = referenceCells[0];
+        const lastCell = referenceCells.pop();
+        const table = firstCell.findAncestor('table');
+        const startLocation = tableUtils.getCellLocation(firstCell);
+        const endLocation = tableUtils.getCellLocation(lastCell);
+        const startColumn = Math.min(startLocation.column, endLocation.column);
+        const endColumn = Math.max(startLocation.column, endLocation.column);
+        const rangesToSelect = [];
+        for (const cellInfo of new TableWalker(table, { startColumn, endColumn })) {
+            rangesToSelect.push(model.createRangeOn(cellInfo.cell));
+        }
+        model.change(writer => {
+            writer.setSelection(rangesToSelect);
+        });
+    }
+}

package/src/commands/selectrowcommand.d.ts

@@ -1,33 +1,33 @@
-/**
- * @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/selectrowcommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core';
-/**
- * The select row command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'selectTableRow'` editor command.
- *
- * To select the rows containing the selected cells, execute the command:
- *
- * ```ts
- * editor.execute( 'selectTableRow' );
- * ```
- */
-export default class SelectRowCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @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/selectrowcommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core';
+/**
+ * The select row command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'selectTableRow'` editor command.
+ *
+ * To select the rows containing the selected cells, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'selectTableRow' );
+ * ```
+ */
+export default class SelectRowCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * @inheritDoc
+     */
+    execute(): void;
+}

package/src/commands/selectrowcommand.js

@@ -1,56 +1,56 @@
-/**
- * @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/selectrowcommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The select row command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'selectTableRow'` editor command.
- *
- * To select the rows containing the selected cells, execute the command:
- *
- * ```ts
- * editor.execute( 'selectTableRow' );
- * ```
- */
-export default class SelectRowCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        // It does not affect data so should be enabled in read-only mode.
-        this.affectsData = false;
-    }
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const selectedCells = tableUtils.getSelectionAffectedTableCells(this.editor.model.document.selection);
-        this.isEnabled = selectedCells.length > 0;
-    }
-    /**
-     * @inheritDoc
-     */
-    execute() {
-        const model = this.editor.model;
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const referenceCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
-        const rowIndexes = tableUtils.getRowIndexes(referenceCells);
-        const table = referenceCells[0].findAncestor('table');
-        const rangesToSelect = [];
-        for (let rowIndex = rowIndexes.first; rowIndex <= rowIndexes.last; rowIndex++) {
-            for (const cell of table.getChild(rowIndex).getChildren()) {
-                rangesToSelect.push(model.createRangeOn(cell));
-            }
-        }
-        model.change(writer => {
-            writer.setSelection(rangesToSelect);
-        });
-    }
-}
+/**
+ * @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/selectrowcommand
+ */
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The select row command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'selectTableRow'` editor command.
+ *
+ * To select the rows containing the selected cells, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'selectTableRow' );
+ * ```
+ */
+export default class SelectRowCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        // It does not affect data so should be enabled in read-only mode.
+        this.affectsData = false;
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const tableUtils = this.editor.plugins.get('TableUtils');
+        const selectedCells = tableUtils.getSelectionAffectedTableCells(this.editor.model.document.selection);
+        this.isEnabled = selectedCells.length > 0;
+    }
+    /**
+     * @inheritDoc
+     */
+    execute() {
+        const model = this.editor.model;
+        const tableUtils = this.editor.plugins.get('TableUtils');
+        const referenceCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
+        const rowIndexes = tableUtils.getRowIndexes(referenceCells);
+        const table = referenceCells[0].findAncestor('table');
+        const rangesToSelect = [];
+        for (let rowIndex = rowIndexes.first; rowIndex <= rowIndexes.last; rowIndex++) {
+            for (const cell of table.getChild(rowIndex).getChildren()) {
+                rangesToSelect.push(model.createRangeOn(cell));
+            }
+        }
+        model.change(writer => {
+            writer.setSelection(rangesToSelect);
+        });
+    }
+}

package/src/commands/setheadercolumncommand.d.ts

@@ -1,50 +1,50 @@
-/**
- * @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/setheadercolumncommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The header column command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'setTableColumnHeader'` editor command.
- *
- * You can make the column containing the selected cell a [header](https://www.w3.org/TR/html50/tabular-data.html#the-th-element)
- * by executing:
- *
- * ```ts
- * editor.execute( 'setTableColumnHeader' );
- * ```
- *
- * **Note:** All preceding columns will also become headers. If the current column is already a header, executing this command
- * will make it a regular column back again (including the following columns).
- */
-export default class SetHeaderColumnCommand extends Command {
-    /**
-     * Flag indicating whether the command is active. The command is active when the
-     * {@link module:engine/model/selection~Selection} is in a header column.
-     *
-     * @observable
-     */
-    value: boolean;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * When the selection is in a non-header column, the command will set the `headingColumns` table attribute to cover that column.
-     *
-     * When the selection is already in a header column, it will set `headingColumns` so the heading section will end before that column.
-     *
-     * @fires execute
-     * @param options.forceValue If set, the command will set (`true`) or unset (`false`) the header columns according to
-     * the `forceValue` parameter instead of the current model state.
-     */
-    execute(options?: {
-        forceValue?: boolean;
-    }): 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/setheadercolumncommand
+ */
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The header column command.
+ *
+ * The command is registered by {@link module:table/tableediting~TableEditing} as the `'setTableColumnHeader'` editor command.
+ *
+ * You can make the column containing the selected cell a [header](https://www.w3.org/TR/html50/tabular-data.html#the-th-element)
+ * by executing:
+ *
+ * ```ts
+ * editor.execute( 'setTableColumnHeader' );
+ * ```
+ *
+ * **Note:** All preceding columns will also become headers. If the current column is already a header, executing this command
+ * will make it a regular column back again (including the following columns).
+ */
+export default class SetHeaderColumnCommand extends Command {
+    /**
+     * Flag indicating whether the command is active. The command is active when the
+     * {@link module:engine/model/selection~Selection} is in a header column.
+     *
+     * @observable
+     */
+    value: boolean;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * When the selection is in a non-header column, the command will set the `headingColumns` table attribute to cover that column.
+     *
+     * When the selection is already in a header column, it will set `headingColumns` so the heading section will end before that column.
+     *
+     * @fires execute
+     * @param options.forceValue If set, the command will set (`true`) or unset (`false`) the header columns according to
+     * the `forceValue` parameter instead of the current model state.
+     */
+    execute(options?: {
+        forceValue?: boolean;
+    }): void;
+}