@ckeditor/ckeditor5-table 40.0.0 → 40.2.0

package/src/tablecolumnresize/constants.d.ts

@@ -1,20 +1,20 @@
-/**
- * @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/tablecolumnresize/constants
- */
-/**
- * The minimum column width given as a percentage value. Used in situations when the table is not yet rendered, so it is impossible to
- * calculate how many percentage of the table width would be {@link ~COLUMN_MIN_WIDTH_IN_PIXELS minimum column width in pixels}.
- */
-export declare const COLUMN_MIN_WIDTH_AS_PERCENTAGE = 5;
-/**
- * The minimum column width in pixels when the maximum table width is known.
- */
-export declare const COLUMN_MIN_WIDTH_IN_PIXELS = 40;
-/**
- * Determines how many digits after the decimal point are used to store the column width as a percentage value.
- */
-export declare const COLUMN_WIDTH_PRECISION = 2;
+/**
+ * @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/tablecolumnresize/constants
+ */
+/**
+ * The minimum column width given as a percentage value. Used in situations when the table is not yet rendered, so it is impossible to
+ * calculate how many percentage of the table width would be {@link ~COLUMN_MIN_WIDTH_IN_PIXELS minimum column width in pixels}.
+ */
+export declare const COLUMN_MIN_WIDTH_AS_PERCENTAGE = 5;
+/**
+ * The minimum column width in pixels when the maximum table width is known.
+ */
+export declare const COLUMN_MIN_WIDTH_IN_PIXELS = 40;
+/**
+ * Determines how many digits after the decimal point are used to store the column width as a percentage value.
+ */
+export declare const COLUMN_WIDTH_PRECISION = 2;

package/src/tablecolumnresize/constants.js

@@ -1,20 +1,20 @@
-/**
- * @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/tablecolumnresize/constants
- */
-/**
- * The minimum column width given as a percentage value. Used in situations when the table is not yet rendered, so it is impossible to
- * calculate how many percentage of the table width would be {@link ~COLUMN_MIN_WIDTH_IN_PIXELS minimum column width in pixels}.
- */
-export const COLUMN_MIN_WIDTH_AS_PERCENTAGE = 5;
-/**
- * The minimum column width in pixels when the maximum table width is known.
- */
-export const COLUMN_MIN_WIDTH_IN_PIXELS = 40;
-/**
- * Determines how many digits after the decimal point are used to store the column width as a percentage value.
- */
-export const COLUMN_WIDTH_PRECISION = 2;
+/**
+ * @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/tablecolumnresize/constants
+ */
+/**
+ * The minimum column width given as a percentage value. Used in situations when the table is not yet rendered, so it is impossible to
+ * calculate how many percentage of the table width would be {@link ~COLUMN_MIN_WIDTH_IN_PIXELS minimum column width in pixels}.
+ */
+export const COLUMN_MIN_WIDTH_AS_PERCENTAGE = 5;
+/**
+ * The minimum column width in pixels when the maximum table width is known.
+ */
+export const COLUMN_MIN_WIDTH_IN_PIXELS = 40;
+/**
+ * Determines how many digits after the decimal point are used to store the column width as a percentage value.
+ */
+export const COLUMN_WIDTH_PRECISION = 2;

package/src/tablecolumnresize/converters.d.ts

@@ -1,18 +1,18 @@
-/**
- * @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/tablecolumnresize/converters
- */
-import type { DowncastDispatcher, UpcastDispatcher } from 'ckeditor5/src/engine';
-import type TableUtils from '../tableutils';
-/**
- * Returns a upcast helper that ensures the number of `<tableColumn>` elements corresponds to the actual number of columns in the table,
- * because the input data might have too few or too many <col> elements.
- */
-export declare function upcastColgroupElement(tableUtilsPlugin: TableUtils): (dispatcher: UpcastDispatcher) => void;
-/**
- * Returns downcast helper for adding `ck-table-resized` class if there is a `<tableColumnGroup>` element inside the table.
- */
-export declare function downcastTableResizedClass(): (dispatcher: DowncastDispatcher) => 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/tablecolumnresize/converters
+ */
+import type { DowncastDispatcher, UpcastDispatcher } from 'ckeditor5/src/engine';
+import type TableUtils from '../tableutils';
+/**
+ * Returns a upcast helper that ensures the number of `<tableColumn>` elements corresponds to the actual number of columns in the table,
+ * because the input data might have too few or too many <col> elements.
+ */
+export declare function upcastColgroupElement(tableUtilsPlugin: TableUtils): (dispatcher: UpcastDispatcher) => void;
+/**
+ * Returns downcast helper for adding `ck-table-resized` class if there is a `<tableColumnGroup>` element inside the table.
+ */
+export declare function downcastTableResizedClass(): (dispatcher: DowncastDispatcher) => void;

package/src/tablecolumnresize/converters.js

@@ -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
- */
-import { normalizeColumnWidths, updateColumnElements, getColumnGroupElement, getTableColumnElements, translateColSpanAttribute } from './utils';
-/**
- * Returns a upcast helper that ensures the number of `<tableColumn>` elements corresponds to the actual number of columns in the table,
- * because the input data might have too few or too many <col> elements.
- */
-export function upcastColgroupElement(tableUtilsPlugin) {
-    return dispatcher => dispatcher.on('element:colgroup', (evt, data, conversionApi) => {
-        const modelTable = data.modelCursor.findAncestor('table');
-        const tableColumnGroup = getColumnGroupElement(modelTable);
-        if (!tableColumnGroup) {
-            return;
-        }
-        const columnElements = getTableColumnElements(tableColumnGroup);
-        const columnsCount = tableUtilsPlugin.getColumns(modelTable);
-        let columnWidths = translateColSpanAttribute(tableColumnGroup, conversionApi.writer);
-        // Fill the array with 'auto' values if the number of columns is higher than number of declared values.
-        columnWidths = Array.from({ length: columnsCount }, (_, index) => columnWidths[index] || 'auto');
-        if (columnWidths.length != columnElements.length || columnWidths.includes('auto')) {
-            updateColumnElements(columnElements, tableColumnGroup, normalizeColumnWidths(columnWidths), conversionApi.writer);
-        }
-    }, { priority: 'low' });
-}
-/**
- * Returns downcast helper for adding `ck-table-resized` class if there is a `<tableColumnGroup>` element inside the table.
- */
-export function downcastTableResizedClass() {
-    return dispatcher => dispatcher.on('insert:table', (evt, data, conversionApi) => {
-        const viewWriter = conversionApi.writer;
-        const modelTable = data.item;
-        const viewElement = conversionApi.mapper.toViewElement(modelTable);
-        const viewTable = viewElement.is('element', 'table') ?
-            viewElement :
-            Array.from(viewElement.getChildren()).find(viewChild => viewChild.is('element', 'table'));
-        const tableColumnGroup = getColumnGroupElement(modelTable);
-        if (tableColumnGroup) {
-            viewWriter.addClass('ck-table-resized', viewTable);
-        }
-        else {
-            viewWriter.removeClass('ck-table-resized', viewTable);
-        }
-    }, { priority: 'low' });
-}
+/**
+ * @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 { normalizeColumnWidths, updateColumnElements, getColumnGroupElement, getTableColumnElements, translateColSpanAttribute } from './utils';
+/**
+ * Returns a upcast helper that ensures the number of `<tableColumn>` elements corresponds to the actual number of columns in the table,
+ * because the input data might have too few or too many <col> elements.
+ */
+export function upcastColgroupElement(tableUtilsPlugin) {
+    return dispatcher => dispatcher.on('element:colgroup', (evt, data, conversionApi) => {
+        const modelTable = data.modelCursor.findAncestor('table');
+        const tableColumnGroup = getColumnGroupElement(modelTable);
+        if (!tableColumnGroup) {
+            return;
+        }
+        const columnElements = getTableColumnElements(tableColumnGroup);
+        const columnsCount = tableUtilsPlugin.getColumns(modelTable);
+        let columnWidths = translateColSpanAttribute(tableColumnGroup, conversionApi.writer);
+        // Fill the array with 'auto' values if the number of columns is higher than number of declared values.
+        columnWidths = Array.from({ length: columnsCount }, (_, index) => columnWidths[index] || 'auto');
+        if (columnWidths.length != columnElements.length || columnWidths.includes('auto')) {
+            updateColumnElements(columnElements, tableColumnGroup, normalizeColumnWidths(columnWidths), conversionApi.writer);
+        }
+    }, { priority: 'low' });
+}
+/**
+ * Returns downcast helper for adding `ck-table-resized` class if there is a `<tableColumnGroup>` element inside the table.
+ */
+export function downcastTableResizedClass() {
+    return dispatcher => dispatcher.on('insert:table', (evt, data, conversionApi) => {
+        const viewWriter = conversionApi.writer;
+        const modelTable = data.item;
+        const viewElement = conversionApi.mapper.toViewElement(modelTable);
+        const viewTable = viewElement.is('element', 'table') ?
+            viewElement :
+            Array.from(viewElement.getChildren()).find(viewChild => viewChild.is('element', 'table'));
+        const tableColumnGroup = getColumnGroupElement(modelTable);
+        if (tableColumnGroup) {
+            viewWriter.addClass('ck-table-resized', viewTable);
+        }
+        else {
+            viewWriter.removeClass('ck-table-resized', viewTable);
+        }
+    }, { priority: 'low' });
+}

package/src/tablecolumnresize/tablecolumnresizeediting.d.ts

@@ -1,139 +1,139 @@
-/**
- * @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 Editor } from 'ckeditor5/src/core';
-import type { Element } from 'ckeditor5/src/engine';
-import TableEditing from '../tableediting';
-import TableUtils from '../tableutils';
-/**
- * The table column resize editing plugin.
- */
-export default class TableColumnResizeEditing extends Plugin {
-    /**
-     * A flag indicating if the column resizing is in progress.
-     */
-    private _isResizingActive;
-    /**
-     * A flag indicating if the column resizing is allowed. It is not allowed if the editor is in read-only
-     * or comments-only mode or the `TableColumnResize` plugin is disabled.
-     *
-     * @observable
-     * @internal
-     */
-    _isResizingAllowed: boolean;
-    /**
-     * A temporary storage for the required data needed to correctly calculate the widths of the resized columns. This storage is
-     * initialized when column resizing begins, and is purged upon completion.
-     */
-    private _resizingData;
-    /**
-     * DOM emitter.
-     */
-    private _domEmitter;
-    /**
-     * A local reference to the {@link module:table/tableutils~TableUtils} plugin.
-     */
-    private _tableUtilsPlugin;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TableEditing, typeof TableUtils];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TableColumnResizeEditing";
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Returns a 'tableColumnGroup' element from the 'table'.
-     *
-     * @param element A 'table' or 'tableColumnGroup' element.
-     * @returns A 'tableColumnGroup' element.
-     */
-    getColumnGroupElement(element: Element): Element | undefined;
-    /**
-     * Returns an array of 'tableColumn' elements.
-     *
-     * @param element A 'table' or 'tableColumnGroup' element.
-     * @returns An array of 'tableColumn' elements.
-     */
-    getTableColumnElements(element: Element): Array<Element>;
-    /**
-     * Returns an array of table column widths.
-     *
-     * @param element A 'table' or 'tableColumnGroup' element.
-     * @returns An array of table column widths.
-     */
-    getTableColumnsWidths(element: Element): Array<string>;
-    /**
-     * Registers new attributes for a table model element.
-     */
-    private _extendSchema;
-    /**
-     * Registers table column resize post-fixer.
-     *
-     * It checks if the change from the differ concerns a table-related element or attribute. For detected changes it:
-     *  * Adjusts the `columnWidths` attribute to guarantee that the sum of the widths from all columns is 100%.
-     *  * Checks if the `columnWidths` attribute gets updated accordingly after columns have been added or removed.
-     */
-    private _registerPostFixer;
-    /**
-     * Registers table column resize converters.
-     */
-    private _registerConverters;
-    /**
-     * Registers listeners to handle resizing process.
-     */
-    private _registerResizingListeners;
-    /**
-     * Handles the `mousedown` event on column resizer element:
-     *  * calculates the initial column pixel widths,
-     *  * inserts the `<colgroup>` element if it is not present in the `<table>`,
-     *  * puts the necessary data in the temporary storage,
-     *  * applies the attributes to the `<table>` view element.
-     *
-     * @param eventInfo An object containing information about the fired event.
-     * @param domEventData The data related to the DOM event.
-     */
-    private _onMouseDownHandler;
-    /**
-     * Handles the `mousemove` event.
-     *  * If resizing process is not in progress, it does nothing.
-     *  * If resizing is active but not allowed, it stops the resizing process instantly calling the `mousedown` event handler.
-     *  * Otherwise it dynamically updates the widths of the resized columns.
-     *
-     * @param eventInfo An object containing information about the fired event.
-     * @param mouseEventData The native DOM event.
-     */
-    private _onMouseMoveHandler;
-    /**
-     * Handles the `mouseup` event.
-     *  * If resizing process is not in progress, it does nothing.
-     *  * If resizing is active but not allowed, it cancels the resizing process restoring the original widths.
-     *  * Otherwise it propagates the changes from view to the model by executing the adequate commands.
-     */
-    private _onMouseUpHandler;
-    /**
-     * Retrieves and returns required data needed for the resizing process.
-     *
-     * @param domEventData The data of the `mousedown` event.
-     * @param columnWidths The current widths of the columns.
-     * @returns The data needed for the resizing process.
-     */
-    private _getResizingData;
-    /**
-     * Registers a listener ensuring that each resizable cell have a resizer handle.
-     */
-    private _registerResizerInserter;
-}
+/**
+ * @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 Editor } from 'ckeditor5/src/core';
+import type { Element } from 'ckeditor5/src/engine';
+import TableEditing from '../tableediting';
+import TableUtils from '../tableutils';
+/**
+ * The table column resize editing plugin.
+ */
+export default class TableColumnResizeEditing extends Plugin {
+    /**
+     * A flag indicating if the column resizing is in progress.
+     */
+    private _isResizingActive;
+    /**
+     * A flag indicating if the column resizing is allowed. It is not allowed if the editor is in read-only
+     * or comments-only mode or the `TableColumnResize` plugin is disabled.
+     *
+     * @observable
+     * @internal
+     */
+    _isResizingAllowed: boolean;
+    /**
+     * A temporary storage for the required data needed to correctly calculate the widths of the resized columns. This storage is
+     * initialized when column resizing begins, and is purged upon completion.
+     */
+    private _resizingData;
+    /**
+     * DOM emitter.
+     */
+    private _domEmitter;
+    /**
+     * A local reference to the {@link module:table/tableutils~TableUtils} plugin.
+     */
+    private _tableUtilsPlugin;
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TableEditing, typeof TableUtils];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TableColumnResizeEditing";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Returns a 'tableColumnGroup' element from the 'table'.
+     *
+     * @param element A 'table' or 'tableColumnGroup' element.
+     * @returns A 'tableColumnGroup' element.
+     */
+    getColumnGroupElement(element: Element): Element | undefined;
+    /**
+     * Returns an array of 'tableColumn' elements.
+     *
+     * @param element A 'table' or 'tableColumnGroup' element.
+     * @returns An array of 'tableColumn' elements.
+     */
+    getTableColumnElements(element: Element): Array<Element>;
+    /**
+     * Returns an array of table column widths.
+     *
+     * @param element A 'table' or 'tableColumnGroup' element.
+     * @returns An array of table column widths.
+     */
+    getTableColumnsWidths(element: Element): Array<string>;
+    /**
+     * Registers new attributes for a table model element.
+     */
+    private _extendSchema;
+    /**
+     * Registers table column resize post-fixer.
+     *
+     * It checks if the change from the differ concerns a table-related element or attribute. For detected changes it:
+     *  * Adjusts the `columnWidths` attribute to guarantee that the sum of the widths from all columns is 100%.
+     *  * Checks if the `columnWidths` attribute gets updated accordingly after columns have been added or removed.
+     */
+    private _registerPostFixer;
+    /**
+     * Registers table column resize converters.
+     */
+    private _registerConverters;
+    /**
+     * Registers listeners to handle resizing process.
+     */
+    private _registerResizingListeners;
+    /**
+     * Handles the `mousedown` event on column resizer element:
+     *  * calculates the initial column pixel widths,
+     *  * inserts the `<colgroup>` element if it is not present in the `<table>`,
+     *  * puts the necessary data in the temporary storage,
+     *  * applies the attributes to the `<table>` view element.
+     *
+     * @param eventInfo An object containing information about the fired event.
+     * @param domEventData The data related to the DOM event.
+     */
+    private _onMouseDownHandler;
+    /**
+     * Handles the `mousemove` event.
+     *  * If resizing process is not in progress, it does nothing.
+     *  * If resizing is active but not allowed, it stops the resizing process instantly calling the `mousedown` event handler.
+     *  * Otherwise it dynamically updates the widths of the resized columns.
+     *
+     * @param eventInfo An object containing information about the fired event.
+     * @param mouseEventData The native DOM event.
+     */
+    private _onMouseMoveHandler;
+    /**
+     * Handles the `mouseup` event.
+     *  * If resizing process is not in progress, it does nothing.
+     *  * If resizing is active but not allowed, it cancels the resizing process restoring the original widths.
+     *  * Otherwise it propagates the changes from view to the model by executing the adequate commands.
+     */
+    private _onMouseUpHandler;
+    /**
+     * Retrieves and returns required data needed for the resizing process.
+     *
+     * @param domEventData The data of the `mousedown` event.
+     * @param columnWidths The current widths of the columns.
+     * @returns The data needed for the resizing process.
+     */
+    private _getResizingData;
+    /**
+     * Registers a listener ensuring that each resizable cell have a resizer handle.
+     */
+    private _registerResizerInserter;
+}