@ckeditor/ckeditor5-table 40.0.0 → 40.1.0

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;
+}

package/src/commands/setheadercolumncommand.js

@@ -1,71 +1,71 @@
-/**
- * @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';
-import { isHeadingColumnCell, updateNumericAttribute } from '../utils/common';
-import { getHorizontallyOverlappingCells, splitVertically } from '../utils/structure';
-/**
- * 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 {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const model = this.editor.model;
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const selectedCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
-        const isInTable = selectedCells.length > 0;
-        this.isEnabled = isInTable;
-        this.value = isInTable && selectedCells.every(cell => isHeadingColumnCell(tableUtils, cell));
-    }
-    /**
-     * 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 = {}) {
-        if (options.forceValue === this.value) {
-            return;
-        }
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const model = this.editor.model;
-        const selectedCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
-        const table = selectedCells[0].findAncestor('table');
-        const { first, last } = tableUtils.getColumnIndexes(selectedCells);
-        const headingColumnsToSet = this.value ? first : last + 1;
-        model.change(writer => {
-            if (headingColumnsToSet) {
-                // Changing heading columns requires to check if any of a heading cell is overlapping horizontally the table head.
-                // Any table cell that has a colspan attribute > 1 will not exceed the table head so we need to fix it in columns before.
-                const overlappingCells = getHorizontallyOverlappingCells(table, headingColumnsToSet);
-                for (const { cell, column } of overlappingCells) {
-                    splitVertically(cell, column, headingColumnsToSet, writer);
-                }
-            }
-            updateNumericAttribute('headingColumns', headingColumnsToSet, table, writer, 0);
-        });
-    }
-}
+/**
+ * @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';
+import { isHeadingColumnCell, updateNumericAttribute } from '../utils/common';
+import { getHorizontallyOverlappingCells, splitVertically } from '../utils/structure';
+/**
+ * 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 {
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const model = this.editor.model;
+        const tableUtils = this.editor.plugins.get('TableUtils');
+        const selectedCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
+        const isInTable = selectedCells.length > 0;
+        this.isEnabled = isInTable;
+        this.value = isInTable && selectedCells.every(cell => isHeadingColumnCell(tableUtils, cell));
+    }
+    /**
+     * 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 = {}) {
+        if (options.forceValue === this.value) {
+            return;
+        }
+        const tableUtils = this.editor.plugins.get('TableUtils');
+        const model = this.editor.model;
+        const selectedCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
+        const table = selectedCells[0].findAncestor('table');
+        const { first, last } = tableUtils.getColumnIndexes(selectedCells);
+        const headingColumnsToSet = this.value ? first : last + 1;
+        model.change(writer => {
+            if (headingColumnsToSet) {
+                // Changing heading columns requires to check if any of a heading cell is overlapping horizontally the table head.
+                // Any table cell that has a colspan attribute > 1 will not exceed the table head so we need to fix it in columns before.
+                const overlappingCells = getHorizontallyOverlappingCells(table, headingColumnsToSet);
+                for (const { cell, column } of overlappingCells) {
+                    splitVertically(cell, column, headingColumnsToSet, writer);
+                }
+            }
+            updateNumericAttribute('headingColumns', headingColumnsToSet, table, writer, 0);
+        });
+    }
+}

package/src/commands/setheaderrowcommand.d.ts

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