@ckeditor/ckeditor5-table 36.0.1 → 37.0.0-alpha.1

package/src/tablecellproperties/commands/tablecellborderwidthcommand.js

@@ -2,14 +2,8 @@
  * @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/tablecellborderwidthcommand
- */
-
 import TableCellPropertyCommand from './tablecellpropertycommand';
 import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-properties';
-
 /**
  * The table cell border width command.
  *
@@ -18,58 +12,53 @@ import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-
  *
  * To change the border width of selected cells, execute the command:
  *
- *		editor.execute( 'tableCellBorderWidth', {
- *			value: '5px'
- *		} );
+ * ```ts
+ * editor.execute( 'tableCellBorderWidth', {
+ *   value: '5px'
+ * } );
+ * ```
  *
  * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
  *
- *		editor.execute( 'tableCellBorderWidth', {
- *			value: '5'
- *		} );
+ * ```ts
+ * editor.execute( 'tableCellBorderWidth', {
+ *   value: '5'
+ * } );
+ * ```
  *
  * will set the `borderWidth` attribute to `'5px'` in the model.
- *
- * @extends module:table/tablecellproperties/commands/tablecellpropertycommand~TableCellPropertyCommand
  */
 export default class TableCellBorderWidthCommand extends TableCellPropertyCommand {
-	/**
-	 * Creates a new `TableCellBorderWidthCommand` instance.
-	 *
-	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
-	 * @param {String} defaultValue The default value of the attribute.
-	 */
-	constructor( editor, defaultValue ) {
-		super( editor, 'tableCellBorderWidth', defaultValue );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	_getAttribute( tableCell ) {
-		if ( !tableCell ) {
-			return;
-		}
-
-		const value = getSingleValue( tableCell.getAttribute( this.attributeName ) );
-
-		if ( value === this._defaultValue ) {
-			return;
-		}
-
-		return value;
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	_getValueToSet( value ) {
-		value = addDefaultUnitToNumericValue( value, 'px' );
-
-		if ( value === this._defaultValue ) {
-			return;
-		}
-
-		return value;
-	}
+    /**
+     * Creates a new `TableCellBorderWidthCommand` 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, 'tableCellBorderWidth', 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/tablecellheightcommand.d.ts

@@ -0,0 +1,46 @@
+/**
+ * @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/tablecellheightcommand
+ */
+import type { Editor } from 'ckeditor5/src/core';
+import TableCellPropertyCommand from './tablecellpropertycommand';
+/**
+ * The table cell height command.
+ *
+ * The command is registered by the {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing} as
+ * the `'tableCellHeight'` editor command.
+ *
+ * To change the height of selected cells, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'tableCellHeight', {
+ *   value: '50px'
+ * } );
+ * ```
+ *
+ * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
+ *
+ * ```ts
+ * editor.execute( 'tableCellHeight', {
+ *   value: '50'
+ * } );
+ * ```
+ *
+ * will set the `height` attribute to `'50px'` in the model.
+ */
+export default class TableCellHeightCommand extends TableCellPropertyCommand {
+    /**
+     * Creates a new `TableCellHeightCommand` instance.
+     *
+     * @param editor An editor in which this command will be used.
+     * @param defaultValue The default value of the attribute.
+     */
+    constructor(editor: Editor, defaultValue: string);
+    /**
+     * @inheritDoc
+     */
+    protected _getValueToSet(value: string | number | undefined): unknown;
+}

package/src/tablecellproperties/commands/tablecellheightcommand.js

@@ -2,14 +2,8 @@
  * @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/tablecellheightcommand
- */
-
 import TableCellPropertyCommand from './tablecellpropertycommand';
 import { addDefaultUnitToNumericValue } from '../../utils/table-properties';
-
 /**
  * The table cell height command.
  *
@@ -18,41 +12,40 @@ import { addDefaultUnitToNumericValue } from '../../utils/table-properties';
  *
  * To change the height of selected cells, execute the command:
  *
- *		editor.execute( 'tableCellHeight', {
- *			value: '50px'
- *		} );
+ * ```ts
+ * editor.execute( 'tableCellHeight', {
+ *   value: '50px'
+ * } );
+ * ```
  *
  * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
  *
- *		editor.execute( 'tableCellHeight', {
- *			value: '50'
- *		} );
+ * ```ts
+ * editor.execute( 'tableCellHeight', {
+ *   value: '50'
+ * } );
+ * ```
  *
  * will set the `height` attribute to `'50px'` in the model.
- *
- * @extends module:table/tablecellproperties/commands/tablecellpropertycommand~TableCellPropertyCommand
  */
 export default class TableCellHeightCommand extends TableCellPropertyCommand {
-	/**
-	 * Creates a new `TableCellHeightCommand` instance.
-	 *
-	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
-	 * @param {String} defaultValue The default value of the attribute.
-	 */
-	constructor( editor, defaultValue ) {
-		super( editor, 'tableCellHeight', defaultValue );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	_getValueToSet( value ) {
-		value = addDefaultUnitToNumericValue( value, 'px' );
-
-		if ( value === this._defaultValue ) {
-			return null;
-		}
-
-		return value;
-	}
+    /**
+     * Creates a new `TableCellHeightCommand` 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, 'tableCellHeight', defaultValue);
+    }
+    /**
+     * @inheritDoc
+     */
+    _getValueToSet(value) {
+        const newValue = addDefaultUnitToNumericValue(value, 'px');
+        if (newValue === this._defaultValue) {
+            return;
+        }
+        return newValue;
+    }
 }

package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.d.ts

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

package/src/tablecellproperties/commands/tablecellhorizontalalignmentcommand.js

@@ -2,13 +2,7 @@
  * @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/tablecellhorizontalalignmentcommand
- */
-
 import TableCellPropertyCommand from './tablecellpropertycommand';
-
 /**
  * The table cell horizontal alignment command.
  *
@@ -17,20 +11,20 @@ import TableCellPropertyCommand from './tablecellpropertycommand';
  *
  * To change the horizontal text alignment of selected cells, execute the command:
  *
- *		editor.execute( 'tableCellHorizontalAlignment', {
- *			value: 'right'
- *		} );
- *
- * @extends module:table/tablecellproperties/commands/tablecellpropertycommand~TableCellPropertyCommand
+ * ```ts
+ * editor.execute( 'tableCellHorizontalAlignment', {
+ *  value: 'right'
+ * } );
+ * ```
  */
 export default class TableCellHorizontalAlignmentCommand extends TableCellPropertyCommand {
-	/**
-	 * Creates a new `TableCellHorizontalAlignmentCommand` instance.
-	 *
-	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
-	 * @param {String} defaultValue The default value for the "alignment" attribute.
-	 */
-	constructor( editor, defaultValue ) {
-		super( editor, 'tableCellHorizontalAlignment', defaultValue );
-	}
+    /**
+     * 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.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @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/tablecellpaddingcommand
+ */
+import type { Editor } from 'ckeditor5/src/core';
+import type { Element } from 'ckeditor5/src/engine';
+import TableCellPropertyCommand from './tablecellpropertycommand';
+/**
+ * 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: Editor, defaultValue: string);
+    /**
+     * @inheritDoc
+     */
+    protected _getAttribute(tableCell: Element): unknown;
+    /**
+     * @inheritDoc
+     */
+    protected _getValueToSet(value: string | number | undefined): unknown;
+}

package/src/tablecellproperties/commands/tablecellpaddingcommand.js

@@ -2,14 +2,8 @@
  * @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/tablecellpaddingcommand
- */
-
 import TableCellPropertyCommand from './tablecellpropertycommand';
 import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-properties';
-
 /**
  * The table cell padding command.
  *
@@ -18,58 +12,53 @@ import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-
  *
  * To change the padding of selected cells, execute the command:
  *
- *		editor.execute( 'tableCellPadding', {
- *			value: '5px'
- *		} );
+ * ```ts
+ * editor.execute( 'tableCellPadding', {
+ *   value: '5px'
+ * } );
+ * ```
  *
  * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
  *
- *		editor.execute( 'tableCellPadding', {
- *			value: '5'
- *		} );
+ * ```ts
+ * editor.execute( 'tableCellPadding', {
+ *   value: '5'
+ * } );
+ * ```
  *
  * will set the `padding` attribute to `'5px'` in the model.
- *
- * @extends module:table/tablecellproperties/commands/tablecellpropertycommand~TableCellPropertyCommand
  */
 export default class TableCellPaddingCommand extends TableCellPropertyCommand {
-	/**
-	 * Creates a new `TableCellPaddingCommand` instance.
-	 *
-	 * @param {module:core/editor/editor~Editor} editor An editor in which this command will be used.
-	 * @param {String} 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 ) {
-		value = addDefaultUnitToNumericValue( value, 'px' );
-
-		if ( value === this._defaultValue ) {
-			return;
-		}
-
-		return value;
-	}
+    /**
+     * 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

@@ -0,0 +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;
+}