@ckeditor/ckeditor5-table 48.8.1-alpha.4 → 49.0.0-alpha.0

package/dist/tablecolumnresize/utils.d.ts

@@ -1,160 +1,199 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module table/tablecolumnresize/utils
- */
-import type { Editor } from '@ckeditor/ckeditor5-core';
-import type { ModelElement, Model, ModelWriter } from '@ckeditor/ckeditor5-engine';
-import { type TableUtils } from '../tableutils.js';
-/**
- * Returns all the inserted or changed table model elements in a given change set. Only the tables
- * with 'columnsWidth' attribute are taken into account. The returned set may be empty.
- *
- * Most notably if an entire table is removed it will not be included in returned set.
- *
- * @internal
- * @param model The model to collect the affected elements from.
- * @returns A set of table model elements.
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+/**
+* @module table/tablecolumnresize/utils
+*/
+import type { Editor } from "@ckeditor/ckeditor5-core";
+import type { ModelElement, Model, ModelWriter } from "@ckeditor/ckeditor5-engine";
+import { type TableUtils } from "../tableutils.js";
+/**
+* Returns all the inserted or changed table model elements in a given change set. Only the tables
+* with 'columnsWidth' attribute are taken into account. The returned set may be empty.
+*
+* Most notably if an entire table is removed it will not be included in returned set.
+*
+* @internal
+* @param model The model to collect the affected elements from.
+* @returns A set of table model elements.
+*/
 export declare function getChangedResizedTables(model: Model): Set<ModelElement>;
 /**
- * Calculates the percentage of the minimum column width given in pixels for a given table.
- *
- * @internal
- * @param modelTable A table model element.
- * @param editor The editor instance.
- * @returns The minimal column width in percentage.
- */
+* Calculates the percentage of the minimum column width given in pixels for a given table.
+*
+* @internal
+* @param modelTable A table model element.
+* @param editor The editor instance.
+* @returns The minimal column width in percentage.
+*/
 export declare function getColumnMinWidthAsPercentage(modelTable: ModelElement, editor: Editor): number;
 /**
- * Calculates the table width in pixels.
- *
- * @internal
- * @param modelTable A table model element.
- * @param editor The editor instance.
- * @returns The width of the table in pixels.
- */
+* Calculates the table width in pixels.
+*
+* @internal
+* @param modelTable A table model element.
+* @param editor The editor instance.
+* @returns The width of the table in pixels.
+*/
 export declare function getTableWidthInPixels(modelTable: ModelElement, editor: Editor): number;
 /**
- * Returns the computed width (in pixels) of the DOM element without padding and borders.
- *
- * @internal
- * @param domElement A DOM element.
- * @returns The width of the DOM element in pixels.
- */
+* Returns the computed width (in pixels) of the DOM element without padding and borders.
+*
+* @internal
+* @param domElement A DOM element.
+* @returns The width of the DOM element in pixels.
+*/
 export declare function getElementWidthInPixels(domElement: HTMLElement): number;
 /**
- * Returns the column indexes on the left and right edges of a cell. They differ if the cell spans
- * across multiple columns.
- *
- * @internal
- * @param cell A table cell model element.
- * @param tableUtils The Table Utils plugin instance.
- * @returns An object containing the indexes of the left and right edges of the cell.
- */
+* Returns the width (in pixels) of a given DOM element's content that's actually available to its children -
+* with the element's own vertical scrollbar subtracted where that's still needed.
+*
+* @internal
+* @param domElement A DOM element.
+* @returns The width available to the element's children, in pixels.
+*/
+export declare function getContainerContentWidth(domElement: HTMLElement): number;
+/**
+* Returns the inner pixel width of a given editing root, or `null` if the root has no
+* DOM element attached yet (e.g. it hasn't been rendered for the first time).
+*
+* @internal
+*/
+export declare function getEditableContentWidth(editor: Editor, rootName: string): number | null;
+/**
+* Returns the column indexes on the left and right edges of a cell. They differ if the cell spans
+* across multiple columns.
+*
+* @internal
+* @param cell A table cell model element.
+* @param tableUtils The Table Utils plugin instance.
+* @returns An object containing the indexes of the left and right edges of the cell.
+*/
 export declare function getColumnEdgesIndexes(cell: ModelElement, tableUtils: TableUtils): {
-    leftEdge: number;
-    rightEdge: number;
+	leftEdge: number;
+	rightEdge: number;
 };
 /**
- * Rounds the provided value to a fixed-point number with defined number of digits after the decimal point.
- *
- * @internal
- * @param value A number to be rounded.
- * @returns The rounded number.
- */
+* Rounds the provided value to a fixed-point number with defined number of digits after the decimal point.
+*
+* @internal
+* @param value A number to be rounded.
+* @returns The rounded number.
+*/
 export declare function toPrecision(value: number | string): number;
 /**
- * Clamps the number within the inclusive lower (min) and upper (max) bounds. Returned number is rounded using the
- * {@link ~toPrecision `toPrecision()`} function.
- *
- * @internal
- * @param number A number to be clamped.
- * @param min A lower bound.
- * @param max An upper bound.
- * @returns The clamped number.
- */
+* Clamps the number within the inclusive lower (min) and upper (max) bounds. Returned number is rounded using the
+* {@link ~toPrecision `toPrecision()`} function.
+*
+* @internal
+* @param number A number to be clamped.
+* @param min A lower bound.
+* @param max An upper bound.
+* @returns The clamped number.
+*/
 export declare function clamp(number: number, min: number, max: number): number;
 /**
- * Creates an array with defined length and fills all elements with defined value.
- *
- * @internal
- * @param length The length of the array.
- * @param value The value to fill the array with.
- * @returns An array with defined length and filled with defined value.
- */
+* Creates an array with defined length and fills all elements with defined value.
+*
+* @internal
+* @param length The length of the array.
+* @param value The value to fill the array with.
+* @returns An array with defined length and filled with defined value.
+*/
 export declare function createFilledArray<T>(length: number, value: T): Array<T>;
 /**
- * Sums all array values that can be parsed to a float.
- *
- * @internal
- * @param array An array of numbers.
- * @returns The sum of all array values.
- */
+* Sums all array values that can be parsed to a float.
+*
+* @internal
+* @param array An array of numbers.
+* @returns The sum of all array values.
+*/
 export declare function sumArray(array: Array<number | string>): number;
 /**
- * Makes sure that the sum of the widths from all columns is 100%. If the sum of all the widths is not equal 100%, all the widths are
- * changed proportionally so that they all sum back to 100%. If there are columns without specified width, the amount remaining
- * after assigning the known widths will be distributed equally between them.
- *
- * @internal
- * @param columnWidths An array of column widths.
- * @returns An array of column widths guaranteed to sum up to 100%.
- */
+* Makes sure that the sum of the widths from all columns is 100%. If the sum of all the widths is not equal 100%, all the widths are
+* changed proportionally so that they all sum back to 100%. If there are columns without specified width, the amount remaining
+* after assigning the known widths will be distributed equally between them.
+*
+* @internal
+* @param columnWidths An array of column widths.
+* @returns An array of column widths guaranteed to sum up to 100%.
+*/
 export declare function normalizeColumnWidths(columnWidths: Array<string>): Array<string>;
 /**
- * Calculates the total horizontal space taken by the cell. That includes:
- *  * width,
- *  * left and red padding,
- *  * border width.
- *
- * @internal
- * @param domCell A DOM cell element.
- * @returns Width in pixels without `px` at the end.
- */
+* Calculates the total horizontal space taken by the cell. That includes:
+*  * width,
+*  * left and red padding,
+*  * border width.
+*
+* @internal
+* @param domCell A DOM cell element.
+* @returns Width in pixels without `px` at the end.
+*/
 export declare function getDomCellOuterWidth(domCell: HTMLElement): number;
 /**
- * Updates column elements to match columns widths.
- *
- * @internal
- * @param columns
- * @param tableColumnGroup
- * @param normalizedWidths
- * @param writer
- */
+* Updates column elements to match columns widths.
+*
+* @internal
+* @param columns
+* @param tableColumnGroup
+* @param normalizedWidths
+* @param writer
+*/
 export declare function updateColumnElements(columns: Array<ModelElement>, tableColumnGroup: ModelElement, normalizedWidths: Array<string>, writer: ModelWriter): void;
 /**
- * Returns a 'tableColumnGroup' element from the 'table'.
- *
- * @internal
- * @param element A 'table' or 'tableColumnGroup' element.
- * @returns A 'tableColumnGroup' element.
- */
+* Returns a 'tableColumnGroup' element from the 'table'.
+*
+* @internal
+* @param element A 'table' or 'tableColumnGroup' element.
+* @returns A 'tableColumnGroup' element.
+*/
 export declare function getColumnGroupElement(element: ModelElement): ModelElement;
 /**
- * Returns an array of 'tableColumn' elements. It may be empty if there's no `tableColumnGroup` element.
- *
- * @internal
- * @param element A 'table' or 'tableColumnGroup' element.
- * @returns An array of 'tableColumn' elements.
- */
+* Returns an array of 'tableColumn' elements. It may be empty if there's no `tableColumnGroup` element.
+*
+* @internal
+* @param element A 'table' or 'tableColumnGroup' element.
+* @returns An array of 'tableColumn' elements.
+*/
 export declare function getTableColumnElements(element: ModelElement): Array<ModelElement>;
 /**
- * Returns an array of table column widths.
- *
- * @internal
- * @param element A 'table' or 'tableColumnGroup' element.
- * @returns An array of table column widths.
- */
+* Returns an array of table column widths.
+*
+* @internal
+* @param element A 'table' or 'tableColumnGroup' element.
+* @returns An array of table column widths.
+*/
 export declare function getTableColumnsWidths(element: ModelElement): Array<string>;
 /**
- * Translates the `colSpan` model attribute into additional column widths and returns the resulting array.
- *
- * @internal
- * @param element A 'table' or 'tableColumnGroup' element.
- * @param writer A writer instance.
- * @returns An array of table column widths.
- */
+* Tells whether a table is in the pixel width mode, that is, its `tableWidth` attribute is expressed in pixels.
+* The `tableWidth` unit is the single source of truth for the whole table's width mode.
+*
+* @internal
+* @param table A 'table' model element.
+*/
+export declare function isTableWidthInPixels(table: ModelElement): boolean;
+/**
+* Tells whether the given column widths are expressed in pixels.
+*
+* @internal
+* @param columnWidths An array of column widths.
+*/
+export declare function isColumnWidthsInPixels(columnWidths: Array<string>): boolean;
+/**
+* Translates the `colSpan` model attribute into additional column widths and returns the resulting array.
+*
+* @internal
+* @param element A 'table' or 'tableColumnGroup' element.
+* @param writer A writer instance.
+* @returns An array of table column widths.
+*/
 export declare function translateColSpanAttribute(element: ModelElement, writer: ModelWriter): Array<string>;
+/**
+* Removes the `tableCellWidth` attribute from every cell of the given table. Once a column is resized (with the resize
+* handler or the column-width command), a per-cell width is obsolete - the column width governs the layout - so it is
+* dropped to keep the model clean.
+*
+* @internal
+*/
+export declare function removeCellWidthsFromTable(writer: ModelWriter, table: ModelElement): void;

package/dist/tablecolumnresize.d.ts

@@ -1,30 +1,29 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module table/tablecolumnresize
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { TableColumnResizeEditing } from './tablecolumnresize/tablecolumnresizeediting.js';
-import { TableCellWidthEditing } from './tablecellwidth/tablecellwidthediting.js';
-import '../theme/tablecolumnresize.css';
+* @module table/tablecolumnresize
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { TableColumnResizeEditing } from "./tablecolumnresize/tablecolumnresizeediting.js";
+import { TableCellWidthEditing } from "./tablecellwidth/tablecellwidthediting.js";
 /**
- * The table column resize feature.
- *
- * It provides the possibility to set the width of each column in a table using a resize handler.
- */
+* The table column resize feature.
+*
+* It provides the possibility to set the width of each column in a table using a resize handler.
+*/
 export declare class TableColumnResize extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TableColumnResizeEditing, typeof TableCellWidthEditing];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TableColumnResize";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[TableColumnResizeEditing, TableCellWidthEditing]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "TableColumnResize";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
 }