@ckeditor/ckeditor5-table 40.0.0 → 40.2.0

package/src/tableproperties/commands/tablepropertycommand.js

@@ -1,80 +1,81 @@
-/**
- * @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 { Command } from 'ckeditor5/src/core';
-/**
- * The table cell attribute command.
- *
- * This command is a base command for other table property commands.
- */
-export default class TablePropertyCommand extends Command {
-    /**
-     * Creates a new `TablePropertyCommand` 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 selection = editor.model.document.selection;
-        const table = selection.getFirstPosition().findAncestor('table');
-        this.isEnabled = !!table;
-        this.value = this._getValue(table);
-    }
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options.value If set, the command will set the attribute on the selected table.
-     * If not set, the command will remove the attribute from the selected table.
-     * @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 model = this.editor.model;
-        const selection = model.document.selection;
-        const { value, batch } = options;
-        const table = selection.getFirstPosition().findAncestor('table');
-        const valueToSet = this._getValueToSet(value);
-        model.enqueueChange(batch, writer => {
-            if (valueToSet) {
-                writer.setAttribute(this.attributeName, valueToSet, table);
-            }
-            else {
-                writer.removeAttribute(this.attributeName, table);
-            }
-        });
-    }
-    /**
-     * Returns the attribute value for a table.
-     */
-    _getValue(table) {
-        if (!table) {
-            return;
-        }
-        const value = table.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;
-    }
-}
+/**
+ * @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 { Command } from 'ckeditor5/src/core';
+import { getSelectionAffectedTable } from '../../utils/common';
+/**
+ * The table cell attribute command.
+ *
+ * This command is a base command for other table property commands.
+ */
+export default class TablePropertyCommand extends Command {
+    /**
+     * Creates a new `TablePropertyCommand` 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 selection = editor.model.document.selection;
+        const table = getSelectionAffectedTable(selection);
+        this.isEnabled = !!table;
+        this.value = this._getValue(table);
+    }
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options.value If set, the command will set the attribute on the selected table.
+     * If not set, the command will remove the attribute from the selected table.
+     * @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 model = this.editor.model;
+        const selection = model.document.selection;
+        const { value, batch } = options;
+        const table = getSelectionAffectedTable(selection);
+        const valueToSet = this._getValueToSet(value);
+        model.enqueueChange(batch, writer => {
+            if (valueToSet) {
+                writer.setAttribute(this.attributeName, valueToSet, table);
+            }
+            else {
+                writer.removeAttribute(this.attributeName, table);
+            }
+        });
+    }
+    /**
+     * Returns the attribute value for a table.
+     */
+    _getValue(table) {
+        if (!table) {
+            return;
+        }
+        const value = table.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;
+    }
+}

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

@@ -1,46 +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/tableproperties/commands/tablewidthcommand
- */
-import TablePropertyCommand from './tablepropertycommand';
-import type { Editor } from 'ckeditor5/src/core';
-/**
- * The table width command.
- *
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * the `'tableWidth'` editor command.
- *
- * To change the width of the selected table, execute the command:
- *
- * ```ts
- * editor.execute( 'tableWidth', {
- *   value: '400px'
- * } );
- * ```
- *
- * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
- *
- * ```ts
- * editor.execute( 'tableWidth', {
- *   value: '50'
- * } );
- * ```
- *
- * will set the `width` attribute to `'50px'` in the model.
- */
-export default class TableWidthCommand extends TablePropertyCommand {
-    /**
-     * Creates a new `TableWidthCommand` 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;
-}
+/**
+ * @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/tablewidthcommand
+ */
+import TablePropertyCommand from './tablepropertycommand';
+import type { Editor } from 'ckeditor5/src/core';
+/**
+ * The table width command.
+ *
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * the `'tableWidth'` editor command.
+ *
+ * To change the width of the selected table, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'tableWidth', {
+ *   value: '400px'
+ * } );
+ * ```
+ *
+ * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
+ *
+ * ```ts
+ * editor.execute( 'tableWidth', {
+ *   value: '50'
+ * } );
+ * ```
+ *
+ * will set the `width` attribute to `'50px'` in the model.
+ */
+export default class TableWidthCommand extends TablePropertyCommand {
+    /**
+     * Creates a new `TableWidthCommand` 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;
+}

package/src/tableproperties/commands/tablewidthcommand.js

@@ -1,54 +1,54 @@
-/**
- * @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/tablewidthcommand
- */
-import TablePropertyCommand from './tablepropertycommand';
-import { addDefaultUnitToNumericValue } from '../../utils/table-properties';
-/**
- * The table width command.
- *
- * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
- * the `'tableWidth'` editor command.
- *
- * To change the width of the selected table, execute the command:
- *
- * ```ts
- * editor.execute( 'tableWidth', {
- *   value: '400px'
- * } );
- * ```
- *
- * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
- *
- * ```ts
- * editor.execute( 'tableWidth', {
- *   value: '50'
- * } );
- * ```
- *
- * will set the `width` attribute to `'50px'` in the model.
- */
-export default class TableWidthCommand extends TablePropertyCommand {
-    /**
-     * Creates a new `TableWidthCommand` 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, 'tableWidth', defaultValue);
-    }
-    /**
-     * @inheritDoc
-     */
-    _getValueToSet(value) {
-        value = addDefaultUnitToNumericValue(value, 'px');
-        if (value === this._defaultValue) {
-            return;
-        }
-        return value;
-    }
-}
+/**
+ * @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/tablewidthcommand
+ */
+import TablePropertyCommand from './tablepropertycommand';
+import { addDefaultUnitToNumericValue } from '../../utils/table-properties';
+/**
+ * The table width command.
+ *
+ * The command is registered by the {@link module:table/tableproperties/tablepropertiesediting~TablePropertiesEditing} as
+ * the `'tableWidth'` editor command.
+ *
+ * To change the width of the selected table, execute the command:
+ *
+ * ```ts
+ * editor.execute( 'tableWidth', {
+ *   value: '400px'
+ * } );
+ * ```
+ *
+ * **Note**: This command adds the default `'px'` unit to numeric values. Executing:
+ *
+ * ```ts
+ * editor.execute( 'tableWidth', {
+ *   value: '50'
+ * } );
+ * ```
+ *
+ * will set the `width` attribute to `'50px'` in the model.
+ */
+export default class TableWidthCommand extends TablePropertyCommand {
+    /**
+     * Creates a new `TableWidthCommand` 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, 'tableWidth', defaultValue);
+    }
+    /**
+     * @inheritDoc
+     */
+    _getValueToSet(value) {
+        value = addDefaultUnitToNumericValue(value, 'px');
+        if (value === this._defaultValue) {
+            return;
+        }
+        return value;
+    }
+}

package/src/tableproperties/tablepropertiesediting.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/tableproperties/tablepropertiesediting
- */
-import { Plugin } from 'ckeditor5/src/core';
-import TableEditing from '../tableediting';
-/**
- * The table properties editing feature.
- *
- * Introduces table's model attributes and their conversion:
- *
- * - border: `tableBorderStyle`, `tableBorderColor` and `tableBorderWidth`
- * - background color: `tableBackgroundColor`
- * - horizontal alignment: `tableAlignment`
- * - width & height: `tableWidth` & `tableHeight`
- *
- * It also registers commands used to manipulate the above attributes:
- *
- * - border: `'tableBorderStyle'`, `'tableBorderColor'` and `'tableBorderWidth'` commands
- * - background color: `'tableBackgroundColor'`
- * - horizontal alignment: `'tableAlignment'`
- * - width & height: `'tableWidth'` & `'tableHeight'`
- */
-export default class TablePropertiesEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TablePropertiesEditing";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TableEditing];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}
+/**
+ * @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/tablepropertiesediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import TableEditing from '../tableediting';
+/**
+ * The table properties editing feature.
+ *
+ * Introduces table's model attributes and their conversion:
+ *
+ * - border: `tableBorderStyle`, `tableBorderColor` and `tableBorderWidth`
+ * - background color: `tableBackgroundColor`
+ * - horizontal alignment: `tableAlignment`
+ * - width & height: `tableWidth` & `tableHeight`
+ *
+ * It also registers commands used to manipulate the above attributes:
+ *
+ * - border: `'tableBorderStyle'`, `'tableBorderColor'` and `'tableBorderWidth'` commands
+ * - background color: `'tableBackgroundColor'`
+ * - horizontal alignment: `'tableAlignment'`
+ * - width & height: `'tableWidth'` & `'tableHeight'`
+ */
+export default class TablePropertiesEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TablePropertiesEditing";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TableEditing];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}