@ckeditor/ckeditor5-table 36.0.0 → 37.0.0-alpha.0

package/src/tableproperties/commands/tablealignmentcommand.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/tableproperties/commands/tablealignmentcommand
- */
-
 import TablePropertyCommand from './tablepropertycommand';
-
 /**
  * The table alignment command.
  *
@@ -17,20 +11,20 @@ import TablePropertyCommand from './tablepropertycommand';
  *
  * To change the alignment of the selected table, execute the command:
  *
- *		editor.execute( 'tableAlignment', {
- *			value: 'right'
- *		} );
- *
- * @extends module:table/tableproperties/commands/tablepropertycommand~TablePropertyCommand
+ * ```ts
+ * editor.execute( 'tableAlignment', {
+ *   value: 'right'
+ * } );
+ * ```
  */
 export default class TableAlignmentCommand extends TablePropertyCommand {
-	/**
-	 * Creates a new `TableAlignmentCommand` 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, 'tableAlignment', defaultValue );
-	}
+    /**
+     * Creates a new `TableAlignmentCommand` 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, 'tableAlignment', defaultValue);
+    }
 }

package/src/tableproperties/commands/tablebackgroundcolorcommand.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @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/tableproperties/commands/tablebackgroundcolorcommand
+ */
+import type { Editor } from 'ckeditor5/src/core';
+import TablePropertyCommand from './tablepropertycommand';
+/**
+ * The table background color command.
+ *
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * the `'tableBackgroundColor'` editor command.
+ *
+ * To change the background color of the selected table, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'tableBackgroundColor', {
+ *   value: '#f00'
+ * } );
+ * ```
+ */
+export default class TableBackgroundColorCommand extends TablePropertyCommand {
+    /**
+     * Creates a new `TableBackgroundColorCommand` 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);
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        tableBackgroundColor: TableBackgroundColorCommand;
+    }
+}

package/src/tableproperties/commands/tablebackgroundcolorcommand.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/tableproperties/commands/tablebackgroundcolorcommand
- */
-
 import TablePropertyCommand from './tablepropertycommand';
-
 /**
  * The table background color command.
  *
@@ -17,20 +11,20 @@ import TablePropertyCommand from './tablepropertycommand';
  *
  * To change the background color of the selected table, execute the command:
  *
- *		editor.execute( 'tableBackgroundColor', {
- *			value: '#f00'
- *		} );
- *
- * @extends module:table/tableproperties/commands/tablepropertycommand~TablePropertyCommand
+ * ```ts
+ * editor.execute( 'tableBackgroundColor', {
+ *   value: '#f00'
+ * } );
+ * ```
  */
 export default class TableBackgroundColorCommand extends TablePropertyCommand {
-	/**
-	 * Creates a new `TableBackgroundColorCommand` 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, 'tableBackgroundColor', defaultValue );
-	}
+    /**
+     * Creates a new `TableBackgroundColorCommand` 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, 'tableBackgroundColor', defaultValue);
+    }
 }

package/src/tableproperties/commands/tablebordercolorcommand.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @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/tableproperties/commands/tablebordercolorcommand
+ */
+import type { Element } from 'ckeditor5/src/engine';
+import type { Editor } from 'ckeditor5/src/core';
+import TablePropertyCommand from './tablepropertycommand';
+/**
+ * The table border color command.
+ *
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * the `'tableBorderColor'` editor command.
+ *
+ * To change the border color of the selected table, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'tableBorderColor', {
+ *   value: '#f00'
+ * } );
+ * ```
+ */
+export default class TableBorderColorCommand extends TablePropertyCommand {
+    /**
+     * Creates a new `TableBorderColorCommand` 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 _getValue(table: Element): unknown;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        tableBorderColor: TableBorderColorCommand;
+    }
+}

package/src/tableproperties/commands/tablebordercolorcommand.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/tableproperties/commands/tablebordercolorcommand
- */
-
 import TablePropertyCommand from './tablepropertycommand';
 import { getSingleValue } from '../../utils/table-properties';
-
 /**
  * The table border color command.
  *
@@ -18,37 +12,33 @@ import { getSingleValue } from '../../utils/table-properties';
  *
  * To change the border color of the selected table, execute the command:
  *
- *		editor.execute( 'tableBorderColor', {
- *			value: '#f00'
- *		} );
- *
- * @extends module:table/tableproperties/commands/tablepropertycommand~TablePropertyCommand
+ * ```ts
+ * editor.execute( 'tableBorderColor', {
+ *   value: '#f00'
+ * } );
+ * ```
  */
 export default class TableBorderColorCommand extends TablePropertyCommand {
-	/**
-	 * Creates a new `TableBorderColorCommand` 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, 'tableBorderColor', defaultValue );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	_getValue( table ) {
-		if ( !table ) {
-			return;
-		}
-
-		const value = getSingleValue( table.getAttribute( this.attributeName ) );
-
-		if ( value === this._defaultValue ) {
-			return;
-		}
-
-		return value;
-	}
+    /**
+     * Creates a new `TableBorderColorCommand` 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, 'tableBorderColor', defaultValue);
+    }
+    /**
+     * @inheritDoc
+     */
+    _getValue(table) {
+        if (!table) {
+            return;
+        }
+        const value = getSingleValue(table.getAttribute(this.attributeName));
+        if (value === this._defaultValue) {
+            return;
+        }
+        return value;
+    }
 }

package/src/tableproperties/commands/tableborderstylecommand.d.ts

@@ -0,0 +1,42 @@
+/**
+ * @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/tableproperties/commands/tableborderstylecommand
+ */
+import type { Element } from 'ckeditor5/src/engine';
+import TablePropertyCommand from './tablepropertycommand';
+import type { Editor } from 'ckeditor5/src/core';
+/**
+ * The table style border command.
+ *
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * the `'tableBorderStyle'` editor command.
+ *
+ * To change the border style of the selected table, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'tableBorderStyle', {
+ *   value: 'dashed'
+ * } );
+ * ```
+ */
+export default class TableBorderStyleCommand extends TablePropertyCommand {
+    /**
+     * Creates a new `TableBorderStyleCommand` 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 _getValue(table: Element): unknown;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        tableBorderStyle: TableBorderStyleCommand;
+    }
+}

package/src/tableproperties/commands/tableborderstylecommand.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/tableproperties/commands/tableborderstylecommand
- */
-
 import TablePropertyCommand from './tablepropertycommand';
 import { getSingleValue } from '../../utils/table-properties';
-
 /**
  * The table style border command.
  *
@@ -18,37 +12,33 @@ import { getSingleValue } from '../../utils/table-properties';
  *
  * To change the border style of the selected table, execute the command:
  *
- *		editor.execute( 'tableBorderStyle', {
- *			value: 'dashed'
- *		} );
- *
- * @extends module:table/tableproperties/commands/tablepropertycommand~TablePropertyCommand
+ * ```ts
+ * editor.execute( 'tableBorderStyle', {
+ *   value: 'dashed'
+ * } );
+ * ```
  */
 export default class TableBorderStyleCommand extends TablePropertyCommand {
-	/**
-	 * Creates a new `TableBorderStyleCommand` 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, 'tableBorderStyle', defaultValue );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	_getValue( table ) {
-		if ( !table ) {
-			return;
-		}
-
-		const value = getSingleValue( table.getAttribute( this.attributeName ) );
-
-		if ( value === this._defaultValue ) {
-			return;
-		}
-
-		return value;
-	}
+    /**
+     * Creates a new `TableBorderStyleCommand` 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, 'tableBorderStyle', defaultValue);
+    }
+    /**
+     * @inheritDoc
+     */
+    _getValue(table) {
+        if (!table) {
+            return;
+        }
+        const value = getSingleValue(table.getAttribute(this.attributeName));
+        if (value === this._defaultValue) {
+            return;
+        }
+        return value;
+    }
 }

package/src/tableproperties/commands/tableborderwidthcommand.d.ts

@@ -0,0 +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/tableproperties/commands/tableborderwidthcommand
+ */
+import type { Element } from 'ckeditor5/src/engine';
+import type { Editor } from 'ckeditor5/src/core';
+import TablePropertyCommand from './tablepropertycommand';
+/**
+ * The table width border command.
+ *
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * the `'tableBorderWidth'` editor command.
+ *
+ * To change the border width of the selected table, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'tableBorderWidth', {
+ *   value: '5px'
+ * } );
+ * ```
+ *
+ * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
+ *
+ * ```ts
+ * editor.execute( 'tableBorderWidth', {
+ *   value: '5'
+ * } );
+ * ```
+ *
+ * will set the `borderWidth` attribute to `'5px'` in the model.
+ */
+export default class TableBorderWidthCommand extends TablePropertyCommand {
+    /**
+     * Creates a new `TableBorderWidthCommand` 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 _getValue(table: Element): string | undefined;
+    /**
+     * @inheritDoc
+     */
+    protected _getValueToSet(value: string | number | undefined): unknown;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        tableBorderWidth: TableBorderWidthCommand;
+    }
+}

package/src/tableproperties/commands/tableborderwidthcommand.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/tableproperties/commands/tableborderwidthcommand
- */
-
 import TablePropertyCommand from './tablepropertycommand';
 import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-properties';
-
 /**
  * The table width border command.
  *
@@ -18,58 +12,53 @@ import { addDefaultUnitToNumericValue, getSingleValue } from '../../utils/table-
  *
  * To change the border width of the selected table, execute the command:
  *
- *		editor.execute( 'tableBorderWidth', {
- *			value: '5px'
- *		} );
+ * ```ts
+ * editor.execute( 'tableBorderWidth', {
+ *   value: '5px'
+ * } );
+ * ```
  *
  * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
  *
- *		editor.execute( 'tableBorderWidth', {
- *			value: '5'
- *		} );
+ * ```ts
+ * editor.execute( 'tableBorderWidth', {
+ *   value: '5'
+ * } );
+ * ```
  *
  * will set the `borderWidth` attribute to `'5px'` in the model.
- *
- * @extends module:table/tableproperties/commands/tablepropertycommand~TablePropertyCommand
  */
 export default class TableBorderWidthCommand extends TablePropertyCommand {
-	/**
-	 * Creates a new `TableBorderWidthCommand` 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, 'tableBorderWidth', defaultValue );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	_getValue( table ) {
-		if ( !table ) {
-			return;
-		}
-
-		const value = getSingleValue( table.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 `TableBorderWidthCommand` 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, 'tableBorderWidth', defaultValue);
+    }
+    /**
+     * @inheritDoc
+     */
+    _getValue(table) {
+        if (!table) {
+            return;
+        }
+        const value = getSingleValue(table.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/tableproperties/commands/tableheightcommand.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/tableproperties/commands/tableheightcommand
+ */
+import TablePropertyCommand from './tablepropertycommand';
+import type { Editor } from 'ckeditor5/src/core';
+/**
+ * The table height command.
+ *
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * the `'tableHeight'` editor command.
+ *
+ * To change the height of the selected table, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'tableHeight', {
+ *   value: '500px'
+ * } );
+ * ```
+ *
+ * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
+ *
+ * ```ts
+ * editor.execute( 'tableHeight', {
+ *   value: '50'
+ * } );
+ * ```
+ *
+ * will set the `height` attribute to `'50px'` in the model.
+ */
+export default class TableHeightCommand extends TablePropertyCommand {
+    /**
+     * Creates a new `TableHeightCommand` 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;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        tableHeight: TableHeightCommand;
+    }
+}