@ckeditor/ckeditor5-table 39.0.1 → 40.0.0

package/src/tablecellproperties/commands/tablecellpaddingcommand.js

@@ -1,64 +1,64 @@
-/**
- * @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 TableCellPropertyCommand from './tablecellpropertycommand';
-import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-properties';
-/**
- * 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 default 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;
-    }
-}
+/**
+ * @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 TableCellPropertyCommand from './tablecellpropertycommand';
+import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-properties';
+/**
+ * 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 default 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.d.ts

@@ -1,62 +1,62 @@
-/**
- * @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/tablecellproperties/commands/tablecellpropertycommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core';
-import type { Element, Batch } from 'ckeditor5/src/engine';
-/**
- * The table cell attribute command.
- *
- * The command is a base command for other table cell property commands.
- */
-export default class TableCellPropertyCommand extends Command {
-    /**
-     * The attribute that will be set by the command.
-     */
-    readonly attributeName: string;
-    /**
-     * The default value for the attribute.
-     */
-    protected readonly _defaultValue: string;
-    /**
-     * 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: Editor, attributeName: string, defaultValue: string);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * 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?: {
-        value?: string | number;
-        batch?: Batch;
-    }): void;
-    /**
-     * Returns the attribute value for a table cell.
-     */
-    protected _getAttribute(tableCell: Element | undefined): unknown;
-    /**
-     * Returns the proper model value. It can be used to add a default unit to numeric values.
-     */
-    protected _getValueToSet(value: string | number | undefined): unknown;
-    /**
-     * Returns a single value for all selected table cells. If the value is the same for all cells,
-     * it will be returned (`undefined` otherwise).
-     */
-    private _getSingleValue;
-}
+/**
+ * @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/tablecellproperties/commands/tablecellpropertycommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core';
+import type { Element, Batch } from 'ckeditor5/src/engine';
+/**
+ * The table cell attribute command.
+ *
+ * The command is a base command for other table cell property commands.
+ */
+export default class TableCellPropertyCommand extends Command {
+    /**
+     * The attribute that will be set by the command.
+     */
+    readonly attributeName: string;
+    /**
+     * The default value for the attribute.
+     */
+    protected readonly _defaultValue: string;
+    /**
+     * 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: Editor, attributeName: string, defaultValue: string);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * 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?: {
+        value?: string | number;
+        batch?: Batch;
+    }): void;
+    /**
+     * Returns the attribute value for a table cell.
+     */
+    protected _getAttribute(tableCell: Element | undefined): unknown;
+    /**
+     * Returns the proper model value. It can be used to add a default unit to numeric values.
+     */
+    protected _getValueToSet(value: string | number | undefined): unknown;
+    /**
+     * Returns a single value for all selected table cells. If the value is the same for all cells,
+     * it will be returned (`undefined` otherwise).
+     */
+    private _getSingleValue;
+}

package/src/tablecellproperties/commands/tablecellpropertycommand.js

@@ -1,92 +1,92 @@
-/**
- * @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/tablecellproperties/commands/tablecellpropertycommand
- */
-import { Command } from 'ckeditor5/src/core';
-/**
- * The table cell attribute command.
- *
- * The command is a base command for other table cell property commands.
- */
-export default class TableCellPropertyCommand extends Command {
-    /**
-     * 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._defaultValue = defaultValue;
-    }
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const editor = this.editor;
-        const tableUtils = this.editor.plugins.get('TableUtils');
-        const selectedTableCells = tableUtils.getSelectionAffectedTableCells(editor.model.document.selection);
-        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));
-            }
-        });
-    }
-    /**
-     * 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;
-    }
-}
+/**
+ * @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/tablecellproperties/commands/tablecellpropertycommand
+ */
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The table cell attribute command.
+ *
+ * The command is a base command for other table cell property commands.
+ */
+export default class TableCellPropertyCommand extends Command {
+    /**
+     * 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._defaultValue = defaultValue;
+    }
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const editor = this.editor;
+        const tableUtils = this.editor.plugins.get('TableUtils');
+        const selectedTableCells = tableUtils.getSelectionAffectedTableCells(editor.model.document.selection);
+        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));
+            }
+        });
+    }
+    /**
+     * 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/tablecellverticalalignmentcommand.d.ts

@@ -1,40 +1,40 @@
-/**
- * @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/tablecellproperties/commands/tablecellverticalalignmentcommand
- */
-import type { Editor } from 'ckeditor5/src/core';
-import TableCellPropertyCommand from './tablecellpropertycommand';
-/**
- * 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 default 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: Editor, defaultValue: string);
-}
+/**
+ * @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/tablecellproperties/commands/tablecellverticalalignmentcommand
+ */
+import type { Editor } from 'ckeditor5/src/core';
+import TableCellPropertyCommand from './tablecellpropertycommand';
+/**
+ * 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 default 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: Editor, defaultValue: string);
+}

package/src/tablecellproperties/commands/tablecellverticalalignmentcommand.js

@@ -1,38 +1,38 @@
-/**
- * @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 TableCellPropertyCommand from './tablecellpropertycommand';
-/**
- * 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 default 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);
-    }
-}
+/**
+ * @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 TableCellPropertyCommand from './tablecellpropertycommand';
+/**
+ * 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 default 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);
+    }
+}