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

package/src/tablecellproperties.d.ts

@@ -0,0 +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/tablecellproperties
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+/**
+ * The table cell properties feature. Enables support for setting properties of table cells (size, border, background, etc.).
+ *
+ * Read more in the {@glink features/table#table-and-cell-styling-tools Table and cell styling tools} section.
+ * See also the {@link module:table/tableproperties~TableProperties} plugin.
+ *
+ * This is a "glue" plugin that loads the
+ * {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing table cell properties editing feature} and
+ * the {@link module:table/tablecellproperties/tablecellpropertiesui~TableCellPropertiesUI table cell properties UI feature}.
+ */
+export default class TableCellProperties extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'TableCellProperties';
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [TableCellProperties.pluginName]: TableCellProperties;
+    }
+}

package/src/tablecellproperties.js

@@ -2,15 +2,12 @@
  * @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
  */
-
 import { Plugin } from 'ckeditor5/src/core';
 import TableCellPropertiesUI from './tablecellproperties/tablecellpropertiesui';
 import TableCellPropertiesEditing from './tablecellproperties/tablecellpropertiesediting';
-
 /**
  * The table cell properties feature. Enables support for setting properties of table cells (size, border, background, etc.).
  *
@@ -20,101 +17,18 @@ import TableCellPropertiesEditing from './tablecellproperties/tablecellpropertie
  * This is a "glue" plugin that loads the
  * {@link module:table/tablecellproperties/tablecellpropertiesediting~TableCellPropertiesEditing table cell properties editing feature} and
  * the {@link module:table/tablecellproperties/tablecellpropertiesui~TableCellPropertiesUI table cell properties UI feature}.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class TableCellProperties extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'TableCellProperties';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ TableCellPropertiesEditing, TableCellPropertiesUI ];
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'TableCellProperties';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [TableCellPropertiesEditing, TableCellPropertiesUI];
+    }
 }
-
-/**
- * The configuration of the table cell properties user interface (balloon). It allows to define:
- *
- * * The color palette for the cell border color style field (`tableCellProperties.borderColors`),
- * * The color palette for the cell background style field (`tableCellProperties.backgroundColors`).
- *
- *		const tableConfig = {
- *			tableCellProperties: {
- *				borderColors: [
- *					{
- *						color: 'hsl(0, 0%, 90%)',
- *						label: 'Light grey'
- *					},
- *					// ...
- *				],
- *				backgroundColors: [
- *					{
- *						color: 'hsl(120, 75%, 60%)',
- *						label: 'Green'
- *					},
- *					// ...
- *				]
- *			}
- *		};
- *
- * * The default styles for table cells (`tableCellProperties.defaultProperties`):
- *
- *		const tableConfig = {
- *			tableCellProperties: {
- *				defaultProperties: {
- *					horizontalAlignment: 'right',
- *					verticalAlignment: 'bottom',
- *					padding: '5px'
- *				}
- *			}
- *		}
- *
- * 	 {@link module:table/tableproperties~TablePropertiesOptions Read more about the supported properties.}
- *
- * **Note**: The `borderColors` and `backgroundColors` options do not impact the data loaded into the editor,
- * i.e. they do not limit or filter the colors in the data. They are used only in the user interface
- * allowing users to pick colors in a more convenient way. The `defaultProperties` option does impact the data.
- * Default values will not be kept in the editor model.
- *
- * The default color palettes for the cell background and the cell border are the same
- * ({@link module:table/utils/ui/table-properties~defaultColors check out their content}).
- *
- * Both color palette configurations must follow the
- * {@link module:table/table~TableColorConfig table color configuration format}.
- *
- * Read more about configuring the table feature in {@link module:table/table~TableConfig}.
- *
- * @member {Object} module:table/table~TableConfig#tableCellProperties
- */
-
-/**
- * The configuration of the table cell default properties feature.
- *
- * @typedef {Object} module:table/tablecellproperties~TableCellPropertiesOptions
- *
- * @property {String} width The default `width` of the table cell.
- *
- * @property {String} height The default `height` of the table cell.
- *
- * @property {String} padding The default `padding` of the table cell.
- *
- * @property {String} backgroundColor The default `background-color` of the table cell.
- *
- * @property {String} borderColor The default `border-color` of the table cell.
- *
- * @property {String} borderWidth The default `border-width` of the table cell.
- *
- * @property {String} [borderStyle='none'] The default `border-style` of the table cell.
- *
- * @property {String} [horizontalAlignment='center'] The default `horizontalAlignment` of the table cell.
- *
- * @property {String} [verticalAlignment='middle'] The default `verticalAlignment` of the table cell.
- */
-

package/src/tablecellwidth/commands/tablecellwidthcommand.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/tablecellwidthcommand
+ */
+import type { Editor } from 'ckeditor5/src/core';
+import TableCellPropertyCommand from '../../tablecellproperties/commands/tablecellpropertycommand';
+/**
+ * The table cell width command.
+ *
+ * The command is registered by the {@link module:table/tablecellwidth/tablecellwidthediting~TableCellWidthEditing} as
+ * the `'tableCellWidth'` editor command.
+ *
+ * To change the width of selected cells, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'tableCellWidth', {
+ *   value: '50px'
+ * } );
+ * ```
+ *
+ * **Note**: This command adds a default `'px'` unit to numeric values. Executing:
+ *
+ * ```ts
+ * editor.execute( 'tableCellWidth', {
+ *   value: '50'
+ * } );
+ * ```
+ *
+ * will set the `width` attribute to `'50px'` in the model.
+ */
+export default class TableCellWidthCommand extends TableCellPropertyCommand {
+    /**
+     * Creates a new `TableCellWidthCommand` 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
+     */
+    _getValueToSet(value: string | number | undefined): unknown;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        tableCellWidth: TableCellWidthCommand;
+    }
+}

package/src/tablecellwidth/commands/tablecellwidthcommand.js

@@ -2,13 +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/tablecellwidthcommand
- */
 import TableCellPropertyCommand from '../../tablecellproperties/commands/tablecellpropertycommand';
 import { addDefaultUnitToNumericValue } from '../../utils/table-properties';
-
 /**
  * The table cell width command.
  *
@@ -17,41 +12,40 @@ import { addDefaultUnitToNumericValue } from '../../utils/table-properties';
  *
  * To change the width of selected cells, execute the command:
  *
- *		editor.execute( 'tableCellWidth', {
- *			value: '50px'
- *		} );
+ * ```ts
+ * editor.execute( 'tableCellWidth', {
+ *   value: '50px'
+ * } );
+ * ```
  *
  * **Note**: This command adds a default `'px'` unit to numeric values. Executing:
  *
- *		editor.execute( 'tableCellWidth', {
- *			value: '50'
- *		} );
+ * ```ts
+ * editor.execute( 'tableCellWidth', {
+ *   value: '50'
+ * } );
+ * ```
  *
  * will set the `width` attribute to `'50px'` in the model.
- *
- * @extends module:table/tablecellproperties/commands/tablecellpropertycommand~TableCellPropertyCommand
  */
 export default class TableCellWidthCommand extends TableCellPropertyCommand {
-	/**
-	 * Creates a new `TableCellWidthCommand` 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, 'tableCellWidth', defaultValue );
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	_getValueToSet( value ) {
-		value = addDefaultUnitToNumericValue( value, 'px' );
-
-		if ( value === this._defaultValue ) {
-			return;
-		}
-
-		return value;
-	}
+    /**
+     * Creates a new `TableCellWidthCommand` 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, 'tableCellWidth', defaultValue);
+    }
+    /**
+     * @inheritDoc
+     */
+    _getValueToSet(value) {
+        value = addDefaultUnitToNumericValue(value, 'px');
+        if (value === this._defaultValue) {
+            return;
+        }
+        return value;
+    }
 }

package/src/tablecellwidth/tablecellwidthediting.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @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/tablecellwidth/tablecellwidthediting
+ */
+import { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+import '../tableconfig';
+/**
+ * The table cell width editing feature.
+ *
+ * Introduces `tableCellWidth` table cell model attribute alongside with its converters
+ * and a command.
+ */
+export default class TableCellWidthEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'TableCellWidthEditing';
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [TableCellWidthEditing.pluginName]: TableCellWidthEditing;
+    }
+}

package/src/tablecellwidth/tablecellwidthediting.js

@@ -2,57 +2,45 @@
  * @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/tablecellwidth/tablecellwidthediting
  */
-
 import { Plugin } from 'ckeditor5/src/core';
-
 import TableEditing from './../tableediting';
 import TableCellWidthCommand from './commands/tablecellwidthcommand';
 import { getNormalizedDefaultProperties } from '../utils/table-properties';
 import { enableProperty } from '../utils/common';
-
+import '../tableconfig';
 /**
  * The table cell width editing feature.
  *
  * Introduces `tableCellWidth` table cell model attribute alongside with its converters
  * and a command.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class TableCellWidthEditing extends Plugin {
-	/**
-	 * @inheritDoc
-	 */
-	static get pluginName() {
-		return 'TableCellWidthEditing';
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	static get requires() {
-		return [ TableEditing ];
-	}
-
-	/**
-	 * @inheritDoc
-	 */
-	init() {
-		const editor = this.editor;
-
-		const defaultTableCellProperties = getNormalizedDefaultProperties(
-			editor.config.get( 'table.tableCellProperties.defaultProperties' )
-		);
-
-		enableProperty( editor.model.schema, editor.conversion, {
-			modelAttribute: 'tableCellWidth',
-			styleName: 'width',
-			defaultValue: defaultTableCellProperties.width
-		} );
-
-		editor.commands.add( 'tableCellWidth', new TableCellWidthCommand( editor, defaultTableCellProperties.width ) );
-	}
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'TableCellWidthEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [TableEditing];
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const defaultTableCellProperties = getNormalizedDefaultProperties(editor.config.get('table.tableCellProperties.defaultProperties'));
+        enableProperty(editor.model.schema, editor.conversion, {
+            modelAttribute: 'tableCellWidth',
+            styleName: 'width',
+            defaultValue: defaultTableCellProperties.width
+        });
+        editor.commands.add('tableCellWidth', new TableCellWidthCommand(editor, defaultTableCellProperties.width));
+    }
 }

package/src/tableclipboard.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @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 { Plugin, type PluginDependencies } from 'ckeditor5/src/core';
+import type { DocumentFragment, Element, Item, Model, Position, Writer } from 'ckeditor5/src/engine';
+import { type TableSlot } from './tablewalker';
+/**
+ * This plugin adds support for copying/cutting/pasting fragments of tables.
+ * It is loaded automatically by the {@link module:table/table~Table} plugin.
+ */
+export default class TableClipboard extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'TableClipboard';
+    /**
+     * @inheritDoc
+     */
+    static get requires(): PluginDependencies;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Copies table content to a clipboard on "copy" & "cut" events.
+     *
+     * @param evt An object containing information about the handled event.
+     * @param data Clipboard event data.
+     */
+    private _onCopyCut;
+    /**
+     * Overrides default {@link module:engine/model/model~Model#insertContent `model.insertContent()`} method to handle pasting table inside
+     * selected table fragment.
+     *
+     * Depending on selected table fragment:
+     * - If a selected table fragment is smaller than paste table it will crop pasted table to match dimensions.
+     * - If dimensions are equal it will replace selected table fragment with a pasted table contents.
+     *
+     * @param content The content to insert.
+     * @param selectable The selection into which the content should be inserted.
+     * If not provided the current model document selection will be used.
+     */
+    private _onInsertContent;
+    /**
+     * Replaces the part of selectedTable with pastedTable.
+     */
+    private _replaceSelectedCellsWithPasted;
+    /**
+     * Replaces a single table slot.
+     *
+     * @returns Inserted table cell or null if slot should remain empty.
+     * @private
+     */
+    _replaceTableSlotCell(tableSlot: TableSlot, cellToInsert: Element | null, insertPosition: Position, writer: Writer): Element | null;
+    /**
+     * Extracts the table for pasting into a table.
+     *
+     * @param content The content to insert.
+     * @param model The editor model.
+     */
+    getTableIfOnlyTableInContent(content: DocumentFragment | Item, model: Model): Element | null;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [TableClipboard.pluginName]: TableClipboard;
+    }
+}