@ckeditor/ckeditor5-table 47.6.1 → 48.0.0-alpha.0

package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js

@@ -1,30 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { TableCellPropertyCommand } from './tablecellpropertycommand.js';
-/**
- * The table cell horizontal alignment command.
- *
- * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
- * the `'tableCellHorizontalAlignment'` editor command.
- *
- * To change the horizontal text alignment of selected cells, execute the command:
- *
- * ```ts
- * editor.execute( 'tableCellHorizontalAlignment', {
- *  value: 'right'
- * } );
- * ```
- */
-export class TableCellHorizontalAlignmentCommand extends TableCellPropertyCommand {
-    /**
-     * Creates a new `TableCellHorizontalAlignmentCommand` instance.
-     *
-     * @param editor An editor in which this command will be used.
-     * @param defaultValue The default value for the "alignment" attribute.
-     */
-    constructor(editor, defaultValue) {
-        super(editor, 'tableCellHorizontalAlignment', defaultValue);
-    }
-}

package/src/tablecellproperties/commands/tablecellpaddingcommand.js

@@ -1,64 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { TableCellPropertyCommand } from './tablecellpropertycommand.js';
-import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-properties.js';
-/**
- * The table cell padding command.
- *
- * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
- * the `'tableCellPadding'` editor command.
- *
- * To change the padding of selected cells, execute the command:
- *
- * ```ts
- * editor.execute( 'tableCellPadding', {
- *   value: '5px'
- * } );
- * ```
- *
- * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
- *
- * ```ts
- * editor.execute( 'tableCellPadding', {
- *   value: '5'
- * } );
- * ```
- *
- * will set the `padding` attribute to `'5px'` in the model.
- */
-export class TableCellPaddingCommand extends TableCellPropertyCommand {
-    /**
-     * Creates a new `TableCellPaddingCommand` instance.
-     *
-     * @param editor An editor in which this command will be used.
-     * @param defaultValue The default value of the attribute.
-     */
-    constructor(editor, defaultValue) {
-        super(editor, 'tableCellPadding', defaultValue);
-    }
-    /**
-     * @inheritDoc
-     */
-    _getAttribute(tableCell) {
-        if (!tableCell) {
-            return;
-        }
-        const value = getSingleValue(tableCell.getAttribute(this.attributeName));
-        if (value === this._defaultValue) {
-            return;
-        }
-        return value;
-    }
-    /**
-     * @inheritDoc
-     */
-    _getValueToSet(value) {
-        const newValue = addDefaultUnitToNumericValue(value, 'px');
-        if (newValue === this._defaultValue) {
-            return;
-        }
-        return newValue;
-    }
-}

package/src/tablecellproperties/commands/tablecellpropertycommand.js

@@ -1,138 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module table/tablecellproperties/commands/tablecellpropertycommand
- */
-import { Command } from 'ckeditor5/src/core.js';
-import { getSelectionAffectedTable } from '../../utils/common.js';
-/**
- * The table cell attribute command.
- *
- * The command is a base command for other table cell property commands.
- */
-export class TableCellPropertyCommand extends Command {
-    /**
-     * The attribute that will be set by the command.
-     */
-    attributeName;
-    /**
-     * The default value for the attribute.
-     *
-     * @readonly
-     */
-    _defaultValue;
-    /**
-     * The default value for the attribute for the content table.
-     */
-    _defaultContentTableValue;
-    /**
-     * The default value for the attribute for the layout table.
-     */
-    _defaultLayoutTableValue;
-    /**
-     * Creates a new `TableCellPropertyCommand` instance.
-     *
-     * @param editor An editor in which this command will be used.
-     * @param attributeName Table cell attribute name.
-     * @param defaultValue The default value of the attribute.
-     */
-    constructor(editor, attributeName, defaultValue) {
-        super(editor);
-        this.attributeName = attributeName;
-        this._defaultContentTableValue = defaultValue;
-        // Hardcoded defaults for layout table.
-        switch (attributeName) {
-            case 'tableCellType':
-                this._defaultLayoutTableValue = 'data';
-                break;
-            case 'tableCellBorderStyle':
-                this._defaultLayoutTableValue = 'none';
-                break;
-            case 'tableCellHorizontalAlignment':
-                this._defaultLayoutTableValue = 'left';
-                break;
-            case 'tableCellVerticalAlignment':
-                this._defaultLayoutTableValue = 'middle';
-                break;
-            default:
-                this._defaultLayoutTableValue = undefined;
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const editor = this.editor;
-        const selection = editor.model.document.selection;
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const selectedTableCells = tableUtils.getSelectionAffectedTableCells(selection);
-        const table = getSelectionAffectedTable(selection);
-        this._defaultValue = !table || table.getAttribute('tableType') !== 'layout' ?
-            this._defaultContentTableValue :
-            this._defaultLayoutTableValue;
-        this.isEnabled = !!selectedTableCells.length;
-        this.value = this._getSingleValue(selectedTableCells);
-    }
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options.value If set, the command will set the attribute on selected table cells.
-     * If it is not set, the command will remove the attribute from the selected table cells.
-     * @param options.batch Pass the model batch instance to the command to aggregate changes,
-     * for example to allow a single undo step for multiple executions.
-     */
-    execute(options = {}) {
-        const { value, batch } = options;
-        const model = this.editor.model;
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const tableCells = tableUtils.getSelectionAffectedTableCells(model.document.selection);
-        const valueToSet = this._getValueToSet(value);
-        model.enqueueChange(batch, writer => {
-            if (valueToSet) {
-                tableCells.forEach(tableCell => writer.setAttribute(this.attributeName, valueToSet, tableCell));
-            }
-            else {
-                tableCells.forEach(tableCell => writer.removeAttribute(this.attributeName, tableCell));
-            }
-            this.fire('afterExecute', {
-                writer,
-                tableCells,
-                valueToSet
-            });
-        });
-    }
-    /**
-     * Returns the attribute value for a table cell.
-     */
-    _getAttribute(tableCell) {
-        if (!tableCell) {
-            return;
-        }
-        const value = tableCell.getAttribute(this.attributeName);
-        if (value === this._defaultValue) {
-            return;
-        }
-        return value;
-    }
-    /**
-     * Returns the proper model value. It can be used to add a default unit to numeric values.
-     */
-    _getValueToSet(value) {
-        if (value === this._defaultValue) {
-            return;
-        }
-        return value;
-    }
-    /**
-     * Returns a single value for all selected table cells. If the value is the same for all cells,
-     * it will be returned (`undefined` otherwise).
-     */
-    _getSingleValue(tableCells) {
-        const firstCellValue = this._getAttribute(tableCells[0]);
-        const everyCellHasAttribute = tableCells.every(tableCells => this._getAttribute(tableCells) === firstCellValue);
-        return everyCellHasAttribute ? firstCellValue : undefined;
-    }
-}

package/src/tablecellproperties/commands/tablecelltypecommand.js

@@ -1,167 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { TableUtils } from '../../tableutils.js';
-import { TableCellPropertyCommand } from './tablecellpropertycommand.js';
-import { groupCellsByTable, getSelectionAffectedTable } from '../../utils/common.js';
-import { TableWalker } from '../../tablewalker.js';
-/**
- * The table cell type command.
- *
- * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
- * the `'tableCellType'` editor command.
- *
- * To change the type of selected cells, execute the command:
- *
- * ```ts
- * editor.execute( 'tableCellType', {
- *   value: 'header'
- * } );
- * ```
- *
- * The `value` can be either `'header'` or `'data'`.
- * It'll return `undefined` if multiple types are selected.
- */
-export class TableCellTypeCommand extends TableCellPropertyCommand {
-    /**
-     * Creates a new `TableCellTypeCommand` instance.
-     *
-     * @param editor An editor in which this command will be used.
-     */
-    constructor(editor) {
-        super(editor, 'tableCellType', 'data');
-        this.on('afterExecute', (_, data) => {
-            const { writer, tableCells } = data;
-            const tableUtils = this.editor.plugins.get(TableUtils);
-            const tablesMap = groupCellsByTable(tableCells);
-            updateTablesHeadingAttributes(tableUtils, writer, tablesMap.keys());
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        super.refresh();
-        const table = getSelectionAffectedTable(this.editor.model.document.selection);
-        if (this.isEnabled && table && table.getAttribute('tableType') === 'layout') {
-            this.isEnabled = false;
-        }
-    }
-    /**
-     * Returns the attribute value for a table cell.
-     */
-    _getAttribute(tableCell) {
-        return tableCell?.getAttribute(this.attributeName) || 'data';
-    }
-}
-/**
- * Updates the `headingRows` and `headingColumns` attributes of the given tables
- * based on the `tableCellType` of their cells.
- */
-export function updateTablesHeadingAttributes(tableUtils, writer, tables) {
-    let changed = false;
-    for (const table of tables) {
-        let headingRows = table.getAttribute('headingRows') || 0;
-        let headingColumns = table.getAttribute('headingColumns') || 0;
-        // Prioritize the dimension that is already larger to prevent the other dimension from
-        // aggressively consuming "orphaned" header cells. In other words, if table has three
-        // heading columns (which fills entire table), we should not count all rows as heading rows.
-        // User might later add column to the right which should not be heading.
-        //
-        // The other example, in a 2x2 table where all cells are headers (e.g. due to concurrent edits),
-        // if headingColumns=0 and headingRows=0 (but all cells are headers):
-        // - Processing rows first would expand headingRows to 2 (covering all cells), leaving headingColumns at 0.
-        // - Processing columns first expands headingColumns to 2, leaving headingRows at 0.
-        //
-        // It should be good enough to resolve conflicts in most cases.
-        const processColumnsFirst = headingColumns > headingRows;
-        if (processColumnsFirst) {
-            const newHeadingColumns = getAdjustedHeadingSectionSize(tableUtils, table, 'column', headingColumns, headingRows);
-            if (newHeadingColumns !== headingColumns) {
-                tableUtils.setHeadingColumnsCount(writer, table, newHeadingColumns, { shallow: true });
-                headingColumns = newHeadingColumns;
-                changed = true;
-            }
-        }
-        const newHeadingRows = getAdjustedHeadingSectionSize(tableUtils, table, 'row', headingRows, headingColumns);
-        if (newHeadingRows !== headingRows) {
-            tableUtils.setHeadingRowsCount(writer, table, newHeadingRows, { shallow: true });
-            headingRows = newHeadingRows;
-            changed = true;
-        }
-        if (!processColumnsFirst) {
-            const newHeadingColumns = getAdjustedHeadingSectionSize(tableUtils, table, 'column', headingColumns, headingRows);
-            if (newHeadingColumns !== headingColumns) {
-                tableUtils.setHeadingColumnsCount(writer, table, newHeadingColumns, { shallow: true });
-                changed = true;
-            }
-        }
-    }
-    return changed;
-}
-/**
- * Calculates the adjusted size of a heading section (rows or columns).
- *
- * The algorithm iterates through rows (or columns) to determine if they should be part of the heading section.
- * A row/column is included if:
- * 1. All its cells are of type 'header'.
- * 2. AND it contains at least one header cell that is NOT already covered by the perpendicular heading section.
- *
- * This check prevents the algorithm from aggressively expanding the heading section when cells are already
- * headers due to the other dimension.
- *
- * Consider a 2x2 table where all cells are headers:
- *
- * ```
- *    C0  C1
- *   +---+---+
- * R0| H | H |
- *   +---+---+
- * R1| H | H |
- *   +---+---+
- * ```
- *
- * If `headingColumns=2`, both C0 and C1 are heading columns.
- * If we want `headingRows=1` (only R0), the algorithm must NOT include R1, even though R1 consists of header cells.
- * R1's cells are headers because of C0 and C1.
- *
- * Without this check, the algorithm would see that R1 is all headers and force `headingRows` to 2.
- * This would prevent the user from reducing `headingRows` from 2 to 1 without converting R1 cells to 'data'
- * (which would incorrectly break C0 and C1).
- */
-function getAdjustedHeadingSectionSize(tableUtils, table, mode, currentSize, perpendicularHeadingSize) {
-    const totalRowsOrColumns = mode === 'row' ? tableUtils.getRows(table) : tableUtils.getColumns(table);
-    let size = currentSize;
-    // Iterate through each row/column to check if all cells are headers.
-    for (let currentIndex = 0; currentIndex < totalRowsOrColumns; currentIndex++) {
-        const walker = new TableWalker(table, { [mode]: currentIndex });
-        let allCellsAreHeaders = true;
-        let hasHeaderOutsidePerpendicularSection = false;
-        // Check each cell in the current row/column.
-        for (const { cell, row, column } of walker) {
-            // If we find a non-header cell, this row/column can't be part of the heading section.
-            if (cell.getAttribute('tableCellType') !== 'header') {
-                allCellsAreHeaders = false;
-                break;
-            }
-            // Check if this header cell extends beyond the perpendicular heading section.
-            // E.g., when checking rows, see if the cell extends beyond headingColumns.
-            const perpendicularIndex = mode === 'row' ? column : row;
-            if (perpendicularIndex >= perpendicularHeadingSize) {
-                hasHeaderOutsidePerpendicularSection = true;
-            }
-        }
-        // If not all cells are headers, we can't extend the heading section any further.
-        if (!allCellsAreHeaders) {
-            // The section cannot extend beyond the last valid header row/column.
-            return Math.min(size, currentIndex);
-        }
-        // If there's a header extending beyond the perpendicular section,
-        // we must include this row/column in the heading section.
-        if (hasHeaderOutsidePerpendicularSection) {
-            size = Math.max(size, currentIndex + 1);
-        }
-    }
-    return Math.min(size, totalRowsOrColumns);
-}

package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js

@@ -1,38 +0,0 @@
-/**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { TableCellPropertyCommand } from './tablecellpropertycommand.js';
-/**
- * The table cell vertical alignment command.
- *
- * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
- * the `'tableCellVerticalAlignment'` editor command.
- *
- * To change the vertical text alignment of selected cells, execute the command:
- *
- * ```ts
- * editor.execute( 'tableCellVerticalAlignment', {
- *   value: 'top'
- * } );
- * ```
- *
- * The following values, corresponding to the
- * [`vertical-align` CSS attribute](https://developer.mozilla.org/en-US/docs/Web/CSS/vertical-align), are allowed:
- *
- * * `'top'`
- * * `'bottom'`
- *
- * The `'middle'` value is the default one so there is no need to set it.
- */
-export class TableCellVerticalAlignmentCommand extends TableCellPropertyCommand {
-    /**
-     * Creates a new `TableCellVerticalAlignmentCommand` instance.
-     *
-     * @param editor An editor in which this command will be used.
-     * @param defaultValue The default value for the "alignment" attribute.
-     */
-    constructor(editor, defaultValue) {
-        super(editor, 'tableCellVerticalAlignment', defaultValue);
-    }
-}