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

package/dist/tablewalker.d.ts

@@ -1,366 +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/tablewalker
- */
-import type { Element, Position } from 'ckeditor5/src/engine.js';
-/**
- * An object with configuration for `TableWalker`.
- */
-export interface TableWalkerOptions {
-    /**
-     * A row index for which this iterator will output cells. Can't be used together with `startRow` and `endRow`.
-     */
-    row?: number | null;
-    /**
-     * A row index from which this iterator should start. Can't be used together with `row`. Default value is 0.
-     */
-    startRow?: number;
-    /**
-     * A row index at which this iterator should end. Can't be used together with `row`.
-     */
-    endRow?: number;
-    /**
-     * A column index for which this iterator will output cells. Can't be used together with `startColumn` and `endColumn`.
-     */
-    column?: number;
-    /**
-     * A column index from which this iterator should start. Can't be used together with `column`. Default value is 0.
-     */
-    startColumn?: number;
-    /**
-     * A column index at which this iterator should end. Can't be used together with `column`.
-     */
-    endColumn?: number;
-    /**
-     * Also return values for spanned cells. Default value is false.
-     */
-    includeAllSlots?: boolean;
-}
-/**
- * The table iterator class. It allows to iterate over table cells. For each cell the iterator yields
- * {@link module:table/tablewalker~TableSlot} with proper table cell attributes.
- */
-export default class TableWalker implements IterableIterator<TableSlot> {
-    /**
-     * The walker's table element.
-     *
-     * @internal
-     */
-    readonly _table: Element;
-    /**
-     * A row index from which this iterator will start.
-     */
-    private readonly _startRow;
-    /**
-     * A row index at which this iterator will end.
-     */
-    private readonly _endRow?;
-    /**
-     * If set, the table walker will only output cells from a given column and following ones or cells that overlap them.
-     */
-    private readonly _startColumn;
-    /**
-     * If set, the table walker will only output cells up to a given column.
-     */
-    private readonly _endColumn?;
-    /**
-     * Enables output of spanned cells that are normally not yielded.
-     */
-    private readonly _includeAllSlots;
-    /**
-     * Row indexes to skip from the iteration.
-     */
-    private readonly _skipRows;
-    /**
-     * The current row index.
-     *
-     * @internal
-     */
-    _row: number;
-    /**
-     * The index of the current row element in the table.
-     *
-     * @internal
-     */
-    _rowIndex: number;
-    /**
-     * The current column index.
-     *
-     * @internal
-     */
-    _column: number;
-    /**
-     * The cell index in a parent row. For spanned cells when {@link #_includeAllSlots} is set to `true`,
-     * this represents the index of the next table cell.
-     *
-     * @internal
-     */
-    _cellIndex: number;
-    /**
-     * Holds a map of spanned cells in a table.
-     */
-    private readonly _spannedCells;
-    /**
-     * Index of the next column where a cell is anchored.
-     */
-    private _nextCellAtColumn;
-    /**
-     * Indicates whether the iterator jumped to (or close to) the start row, ignoring rows that don't need to be traversed.
-     */
-    private _jumpedToStartRow;
-    /**
-     * Creates an instance of the table walker.
-     *
-     * The table walker iterates internally by traversing the table from row index = 0 and column index = 0.
-     * It walks row by row and column by column in order to output values defined in the constructor.
-     * By default it will output only the locations that are occupied by a cell. To include also spanned rows and columns,
-     * pass the `includeAllSlots` option to the constructor.
-     *
-     * The most important values of the iterator are column and row indexes of a cell.
-     *
-     * See {@link module:table/tablewalker~TableSlot} what values are returned by the table walker.
-     *
-     * To iterate over a given row:
-     *
-     * ```ts
-     * const tableWalker = new TableWalker( table, { startRow: 1, endRow: 2 } );
-     *
-     * for ( const tableSlot of tableWalker ) {
-     *   console.log( 'A cell at row', tableSlot.row, 'and column', tableSlot.column );
-     * }
-     * ```
-     *
-     * For instance the code above for the following table:
-     *
-     *  +----+----+----+----+----+----+
-     *  | 00      | 02 | 03 | 04 | 05 |
-     *  |         +----+----+----+----+
-     *  |         | 12      | 14 | 15 |
-     *  |         +----+----+----+    +
-     *  |         | 22           |    |
-     *  |----+----+----+----+----+    +
-     *  | 30 | 31 | 32 | 33 | 34 |    |
-     *  +----+----+----+----+----+----+
-     *
-     * will log in the console:
-     *
-     *  'A cell at row 1 and column 2'
-     *  'A cell at row 1 and column 4'
-     *  'A cell at row 1 and column 5'
-     *  'A cell at row 2 and column 2'
-     *
-     * To also iterate over spanned cells:
-     *
-     * ```ts
-     * const tableWalker = new TableWalker( table, { row: 1, includeAllSlots: true } );
-     *
-     * for ( const tableSlot of tableWalker ) {
-     *   console.log( 'Slot at', tableSlot.row, 'x', tableSlot.column, ':', tableSlot.isAnchor ? 'is anchored' : 'is spanned' );
-     * }
-     * ```
-     *
-     * will log in the console for the table from the previous example:
-     *
-     *  'Cell at 1 x 0 : is spanned'
-     *  'Cell at 1 x 1 : is spanned'
-     *  'Cell at 1 x 2 : is anchored'
-     *  'Cell at 1 x 3 : is spanned'
-     *  'Cell at 1 x 4 : is anchored'
-     *  'Cell at 1 x 5 : is anchored'
-     *
-     * **Note**: Option `row` is a shortcut that sets both `startRow` and `endRow` to the same row.
-     * (Use either `row` or `startRow` and `endRow` but never together). Similarly the `column` option sets both `startColumn`
-     * and `endColumn` to the same column (Use either `column` or `startColumn` and `endColumn` but never together).
-     *
-     * @param table A table over which the walker iterates.
-     * @param options An object with configuration.
-     * @param options.row A row index for which this iterator will output cells. Can't be used together with `startRow` and `endRow`.
-     * @param options.startRow A row index from which this iterator should start. Can't be used together with `row`. Default value is 0.
-     * @param options.endRow A row index at which this iterator should end. Can't be used together with `row`.
-     * @param options.column A column index for which this iterator will output cells.
-     * Can't be used together with `startColumn` and `endColumn`.
-     * @param options.startColumn A column index from which this iterator should start.
-     * Can't be used together with `column`. Default value is 0.
-     * @param options.endColumn A column index at which this iterator should end. Can't be used together with `column`.
-     * @param options.includeAllSlots Also return values for spanned cells. Default value is "false".
-     */
-    constructor(table: Element, options?: TableWalkerOptions);
-    /**
-     * Iterable interface.
-     */
-    [Symbol.iterator](): IterableIterator<TableSlot>;
-    /**
-     * Gets the next table walker's value.
-     *
-     * @returns The next table walker's value.
-     */
-    next(): IteratorResult<TableSlot, undefined>;
-    /**
-     * Marks a row to skip in the next iteration. It will also skip cells from the current row if there are any cells from the current row
-     * to output.
-     *
-     * @param row The row index to skip.
-     */
-    skipRow(row: number): void;
-    /**
-     * Advances internal cursor to the next row.
-     */
-    private _advanceToNextRow;
-    /**
-     * Checks if the current row is over {@link #_endRow}.
-     */
-    private _isOverEndRow;
-    /**
-     * Checks if the current cell is over {@link #_endColumn}
-     */
-    private _isOverEndColumn;
-    /**
-     * A common method for formatting the iterator's output value.
-     *
-     * @param cell The table cell to output.
-     * @param anchorRow The row index of a cell anchor slot.
-     * @param anchorColumn The column index of a cell anchor slot.
-     */
-    private _formatOutValue;
-    /**
-     * Checks if the current slot should be skipped.
-     */
-    private _shouldSkipSlot;
-    /**
-     * Returns the cell element that is spanned over the current cell location.
-     */
-    private _getSpanned;
-    /**
-     * Updates spanned cells map relative to the current cell location and its span dimensions.
-     *
-     * @param cell A cell that is spanned.
-     * @param rowspan Cell height.
-     * @param colspan Cell width.
-     */
-    private _recordSpans;
-    /**
-     * Marks the cell location as spanned by another cell.
-     *
-     * @param row The row index of the cell location.
-     * @param column The column index of the cell location.
-     * @param data A spanned cell details (cell element, anchor row and column).
-     */
-    private _markSpannedCell;
-    /**
-     * Checks if part of the table can be skipped.
-     */
-    private _canJumpToStartRow;
-    /**
-     * Sets the current row to `this._startRow` or the first row before it that has the number of cells
-     * equal to the number of columns in the table.
-     *
-     * Example:
-     * 	+----+----+----+
-     *  | 00 | 01 | 02 |
-     *  |----+----+----+
-     *  | 10      | 12 |
-     *  |         +----+
-     *  |         | 22 |
-     *  |         +----+
-     *  |         | 32 | <--- Start row
-     *  +----+----+----+
-     *  | 40 | 41 | 42 |
-     *  +----+----+----+
-     *
-     * If the 4th row is a `this._startRow`, this method will:
-     * 1.) Count the number of columns this table has based on the first row (3 columns in this case).
-     * 2.) Check if the 4th row contains 3 cells. It doesn't, so go to the row before it.
-     * 3.) Check if the 3rd row contains 3 cells. It doesn't, so go to the row before it.
-     * 4.) Check if the 2nd row contains 3 cells. It does, so set the current row to that row.
-     *
-     * Setting the current row this way is necessary to let the `next()`  method loop over the cells
-     * spanning multiple rows or columns and update the `this._spannedCells` property.
-     */
-    private _jumpToNonSpannedRowClosestToStartRow;
-    /**
-     * Returns a number of columns in a row taking `colspan` into consideration.
-     */
-    private _getRowLength;
-}
-/**
- * An object returned by {@link module:table/tablewalker~TableWalker} when traversing table cells.
- */
-declare class TableSlot {
-    /**
-     * The current table cell.
-     */
-    readonly cell: Element;
-    /**
-     * The row index of a table slot.
-     */
-    readonly row: number;
-    /**
-     * The column index of a table slot.
-     */
-    readonly column: number;
-    /**
-     * The row index of a cell anchor slot.
-     */
-    readonly cellAnchorRow: number;
-    /**
-     * The column index of a cell anchor slot.
-     */
-    readonly cellAnchorColumn: number;
-    /**
-     * The index of the current cell in the parent row.
-     */
-    private readonly _cellIndex;
-    /**
-     * The index of the current row element in the table.
-     */
-    private readonly _rowIndex;
-    /**
-     * The table element.
-     */
-    private readonly _table;
-    /**
-     * Creates an instance of the table walker value.
-     *
-     * @param tableWalker The table walker instance.
-     * @param cell The current table cell.
-     * @param anchorRow The row index of a cell anchor slot.
-     * @param anchorColumn The column index of a cell anchor slot.
-     */
-    constructor(tableWalker: TableWalker, cell: Element, anchorRow: number, anchorColumn: number);
-    /**
-     * Whether the cell is anchored in the current slot.
-     */
-    get isAnchor(): boolean;
-    /**
-     * The width of a cell defined by a `colspan` attribute. If the model attribute is not present, it is set to `1`.
-     */
-    get cellWidth(): number;
-    /**
-     * The height of a cell defined by a `rowspan` attribute. If the model attribute is not present, it is set to `1`.
-     */
-    get cellHeight(): number;
-    /**
-     * The index of the current row element in the table.
-     */
-    get rowIndex(): number;
-    /**
-     * Returns the {@link module:engine/model/position~Position} before the table slot.
-     */
-    getPositionBefore(): Position;
-}
-export type { TableSlot };
-/**
- * This `TableSlot`'s getter (property) was removed in CKEditor 5 v20.0.0.
- *
- * Check out the new `TableWalker`'s API in the documentation.
- *
- * @error tableslot-getter-removed
- * @param getterName
- */

package/dist/ui/colorinputview.d.ts

@@ -1,144 +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/ui/colorinputview
- */
-import { View, InputTextView, FocusCycler, ViewCollection, type ColorDefinition, type DropdownView, type ColorPickerConfig, type FocusableView } from 'ckeditor5/src/ui.js';
-import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
-import '../../theme/colorinput.css';
-export type ColorInputViewOptions = {
-    colorDefinitions: Array<ColorDefinition>;
-    columns: number;
-    defaultColorValue?: string;
-    colorPickerConfig: false | ColorPickerConfig;
-};
-/**
- * The color input view class. It allows the user to type in a color (hex, rgb, etc.)
- * or choose it from the configurable color palette with a preview.
- *
- * @internal
- */
-export default class ColorInputView extends View implements FocusableView {
-    /**
-     * The value of the input.
-     *
-     * @observable
-     * @default ''
-     */
-    value: string;
-    /**
-     * Controls whether the input view is in read-only mode.
-     *
-     * @observable
-     * @default false
-     */
-    isReadOnly: boolean;
-    /**
-     * An observable flag set to `true` when the input is focused by the user.
-     * `false` otherwise.
-     *
-     * @observable
-     * @default false
-     */
-    readonly isFocused: boolean;
-    /**
-     * An observable flag set to `true` when the input contains no text.
-     *
-     * @observable
-     * @default true
-     */
-    readonly isEmpty: boolean;
-    /**
-     * @observable
-     */
-    hasError: boolean;
-    /**
-     * A cached reference to the options passed to the constructor.
-     */
-    options: ColorInputViewOptions;
-    /**
-     * Tracks information about the DOM focus in the view.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * Helps cycling over focusable children in the input view.
-     */
-    readonly focusCycler: FocusCycler;
-    /**
-     * A collection of views that can be focused in the view.
-     */
-    protected readonly _focusables: ViewCollection<FocusableView>;
-    /**
-     * An instance of the dropdown allowing to select a color from a grid.
-     */
-    dropdownView: DropdownView;
-    /**
-     * An instance of the input allowing the user to type a color value.
-     */
-    inputView: InputTextView;
-    /**
-     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * The flag that indicates whether the user is still typing.
-     * If set to true, it means that the text input field ({@link #inputView}) still has the focus.
-     * So, we should interrupt the user by replacing the input's value.
-     */
-    protected _stillTyping: boolean;
-    /**
-     * Creates an instance of the color input view.
-     *
-     * @param locale The locale instance.
-     * @param options The input options.
-     * @param options.colorDefinitions The colors to be displayed in the palette inside the input's dropdown.
-     * @param options.columns The number of columns in which the colors will be displayed.
-     * @param options.defaultColorValue If specified, the color input view will replace the "Remove color" button with
-     * the "Restore default" button. Instead of clearing the input field, the default color value will be set.
-     */
-    constructor(locale: Locale, options: ColorInputViewOptions);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Focuses the view.
-     */
-    focus(direction: 1 | -1): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Creates and configures the {@link #dropdownView}.
-     */
-    private _createDropdownView;
-    /**
-     * Creates and configures an instance of {@link module:ui/inputtext/inputtextview~InputTextView}.
-     *
-     * @returns A configured instance to be set as {@link #inputView}.
-     */
-    private _createInputTextView;
-    /**
-     * Creates and configures the panel with "color grid" and "color picker" inside the {@link #dropdownView}.
-     */
-    private _createColorSelector;
-    /**
-     * Sets {@link #inputView}'s value property to the color value or color label,
-     * if there is one and the user is not typing.
-     *
-     * Handles cases like:
-     *
-     * * Someone picks the color in the grid.
-     * * The color is set from the plugin level.
-     *
-     * @param inputValue Color value to be set.
-     */
-    private _setInputValue;
-}

package/dist/ui/formrowview.d.ts

@@ -1,65 +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/ui/formrowview
- */
-import { View, type LabelView, type ViewCollection } from 'ckeditor5/src/ui.js';
-import type { Locale } from 'ckeditor5/src/utils.js';
-import '../../theme/formrow.css';
-/**
- * The class representing a single row in a complex form,
- * used by {@link module:table/tablecellproperties/ui/tablecellpropertiesview~TableCellPropertiesView}.
- *
- * **Note**: For now this class is private. When more use cases arrive (beyond ckeditor5-table),
- * it will become a component in ckeditor5-ui.
- *
- * @internal
- */
-export default class FormRowView extends View {
-    /**
-     * An additional CSS class added to the {@link #element}.
-     *
-     * @observable
-     */
-    class: string | null;
-    /**
-     * A collection of row items (buttons, dropdowns, etc.).
-     */
-    readonly children: ViewCollection;
-    /**
-     * The role property reflected by the `role` DOM attribute of the {@link #element}.
-     *
-     * **Note**: Used only when a `labelView` is passed to constructor `options`.
-     *
-     * @observable
-     * @internal
-     */
-    _role: string | null;
-    /**
-     * The ARIA property reflected by the `aria-labelledby` DOM attribute of the {@link #element}.
-     *
-     * **Note**: Used only when a `labelView` is passed to constructor `options`.
-     *
-     * @observable
-     * @internal
-     */
-    _ariaLabelledBy: string | null;
-    /**
-     * Creates an instance of the form row class.
-     *
-     * @param locale The locale instance.
-     * @param options.labelView When passed, the row gets the `group` and `aria-labelledby`
-     * DOM attributes and gets described by the label.
-     */
-    constructor(locale: Locale, options?: {
-        children?: Array<View>;
-        class?: string;
-        labelView?: LabelView;
-    });
-}

package/dist/ui/inserttableview.d.ts

@@ -1,85 +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/ui/inserttableview
- */
-import { View, ButtonView, type ViewCollection } from 'ckeditor5/src/ui.js';
-import { KeystrokeHandler, FocusTracker, type Locale } from 'ckeditor5/src/utils.js';
-import './../../theme/inserttable.css';
-/**
- * The table size view.
- *
- * It renders a 10x10 grid to choose the inserted table size.
- */
-export default class InsertTableView extends View {
-    /**
-     * A collection of table size box items.
-     */
-    readonly items: ViewCollection<ButtonView>;
-    /**
-     * Listen to `keydown` events fired in this view's main element.
-     */
-    readonly keystrokes: KeystrokeHandler;
-    /**
-     * Tracks information about the DOM focus in the grid.
-     */
-    readonly focusTracker: FocusTracker;
-    /**
-     * The currently selected number of rows of the new table.
-     *
-     * @observable
-     */
-    rows: number;
-    /**
-     * The currently selected number of columns of the new table.
-     *
-     * @observable
-     */
-    columns: number;
-    /**
-     * The label text displayed under the boxes.
-     *
-     * @observable
-     */
-    label: string;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale: Locale);
-    render(): void;
-    /**
-     * Resets the rows and columns selection.
-     */
-    reset(): void;
-    /**
-     * @inheritDoc
-     */
-    focus(): void;
-    /**
-     * @inheritDoc
-     */
-    focusLast(): void;
-    /**
-     * Highlights grid boxes depending on rows and columns selected.
-     */
-    private _highlightGridBoxes;
-    /**
-     * Creates a new Button for the grid.
-     *
-     * @param locale The locale instance.
-     * @param row Row number.
-     * @param column Column number.
-     * @param label The grid button label.
-     */
-    private _createGridButton;
-    /**
-     * @returns A view collection containing boxes to be placed in a table grid.
-     */
-    private _createGridCollection;
-}