@ckeditor/ckeditor5-table 44.1.0 → 44.2.0-alpha.1

package/dist/tablecellwidth/tablecellwidthediting.d.ts

@@ -1,37 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-/**
- * @module table/tablecellwidth/tablecellwidthediting
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import TableEditing from './../tableediting.js';
-/**
- * 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 isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TableEditing];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/tableclipboard.d.ts

@@ -1,78 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { ClipboardPipeline, ClipboardMarkersUtils } from 'ckeditor5/src/clipboard.js';
-import { Plugin } from 'ckeditor5/src/core.js';
-import type { DocumentFragment, Element, Item, Model, Position, Writer } from 'ckeditor5/src/engine.js';
-import TableSelection from './tableselection.js';
-import { type TableSlot } from './tablewalker.js';
-import TableUtils from './tableutils.js';
-/**
- * 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 isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ClipboardMarkersUtils, typeof ClipboardPipeline, typeof TableSelection, typeof TableUtils];
-    /**
-     * @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;
-    /**
-     * Inserts provided `selectedTableCells` into `pastedTable`.
-     */
-    private _replaceSelectedCells;
-    /**
-     * 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;
-}

package/dist/tablecolumnresize/constants.d.ts

@@ -1,24 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/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/dist/tablecolumnresize/converters.d.ts

@@ -1,22 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/converters
- */
-import type { DowncastDispatcher, UpcastDispatcher } from 'ckeditor5/src/engine.js';
-import type TableUtils from '../tableutils.js';
-/**
- * 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/dist/tablecolumnresize/tablecolumnresizeediting.d.ts

@@ -1,147 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import type { Element } from 'ckeditor5/src/engine.js';
-import TableEditing from '../tableediting.js';
-import TableUtils from '../tableutils.js';
-/**
- * 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
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @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;
-}

package/dist/tablecolumnresize/tablewidthscommand.d.ts

@@ -1,42 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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/tablewidthscommand
- */
-import type { Element } from 'ckeditor5/src/engine.js';
-import { Command } from 'ckeditor5/src/core.js';
-/**
- * Command used by the {@link module:table/tablecolumnresize~TableColumnResize Table column resize feature} that
- * updates the width of the whole table as well as its individual columns.
- */
-export default class TableWidthsCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Updated the `tableWidth` attribute of the table and the `columnWidth` attribute of the columns of that table.
-     */
-    execute(options?: TableWidthsCommandOptions): void;
-}
-export interface TableWidthsCommandOptions {
-    /**
-     * New value of the `columnWidths` attribute. Must be array of strings or string with comma-separated values.
-     * If skipped, the column widths information will be deleted.
-     */
-    columnWidths?: Array<string> | string;
-    /**
-     * The new table width. If skipped, the model attribute will be removed.
-     */
-    tableWidth?: string;
-    /**
-     * The table that is having the columns resized.
-     */
-    table?: Element;
-}

package/dist/tablecolumnresize/utils.d.ts

@@ -1,152 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, 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 'ckeditor5/src/core.js';
-import type { Element, Model, Writer } from 'ckeditor5/src/engine.js';
-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.
- *
- * @param model The model to collect the affected elements from.
- * @returns A set of table model elements.
- */
-export declare function getChangedResizedTables(model: Model): Set<Element>;
-/**
- * Calculates the percentage of the minimum column width given in pixels for a given table.
- *
- * @param modelTable A table model element.
- * @param editor The editor instance.
- * @returns The minimal column width in percentage.
- */
-export declare function getColumnMinWidthAsPercentage(modelTable: Element, editor: Editor): number;
-/**
- * Calculates the table width in pixels.
- *
- * @param modelTable A table model element.
- * @param editor The editor instance.
- * @returns The width of the table in pixels.
- */
-export declare function getTableWidthInPixels(modelTable: Element, editor: Editor): number;
-/**
- * Returns the computed width (in pixels) of the DOM element without padding and borders.
- *
- * @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.
- *
- * @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: Element, tableUtils: TableUtils): {
-    leftEdge: number;
-    rightEdge: number;
-};
-/**
- * Rounds the provided value to a fixed-point number with defined number of digits after the decimal point.
- *
- * @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.
- *
- * @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.
- *
- * @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.
- *
- * @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.
- *
- * @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.
- *
- * @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.
- *
- * @param columns
- * @param tableColumnGroup
- * @param normalizedWidths
- * @param writer
- */
-export declare function updateColumnElements(columns: Array<Element>, tableColumnGroup: Element, normalizedWidths: Array<string>, writer: Writer): void;
-/**
- * Returns a 'tableColumnGroup' element from the 'table'.
- *
- * @internal
- * @param element A 'table' or 'tableColumnGroup' element.
- * @returns A 'tableColumnGroup' element.
- */
-export declare function getColumnGroupElement(element: Element): Element;
-/**
- * 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: Element): Array<Element>;
-/**
- * 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: Element): 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.
- */
-export declare function translateColSpanAttribute(element: Element, writer: Writer): Array<string>;

package/dist/tablecolumnresize.d.ts

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