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

package/dist/commands/setheaderrowcommand.d.ts

@@ -1,57 +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/commands/setheaderrowcommand
- */
-import { Command } from 'ckeditor5/src/core.js';
-/**
- * The header row command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'setTableColumnHeader'` editor command.
- *
- * You can make the row containing the selected cell a [header](https://www.w3.org/TR/html50/tabular-data.html#the-th-element) by executing:
- *
- * ```ts
- * editor.execute( 'setTableRowHeader' );
- * ```
- *
- * **Note:** All preceding rows will also become headers. If the current row is already a header, executing this command
- * will make it a regular row back again (including the following rows).
- */
-export default class SetHeaderRowCommand extends Command {
-    /**
-     * Flag indicating whether the command is active. The command is active when the
-     * {@link module:engine/model/selection~Selection} is in a header row.
-     *
-     * @observable
-     */
-    value: boolean;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * When the selection is in a non-header row, the command will set the `headingRows` table attribute to cover that row.
-     *
-     * When the selection is already in a header row, it will set `headingRows` so the heading section will end before that row.
-     *
-     * @fires execute
-     * @param options.forceValue If set, the command will set (`true`) or unset (`false`) the header rows according to
-     * the `forceValue` parameter instead of the current model state.
-     */
-    execute(options?: {
-        forceValue?: boolean;
-    }): void;
-    /**
-     * Checks if a table cell is in the heading section.
-     */
-    private _isInHeading;
-}

package/dist/commands/splitcellcommand.d.ts

@@ -1,47 +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/commands/splitcellcommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core.js';
-/**
- * The split cell command.
- *
- * The command is registered by {@link module:table/tableediting~TableEditing} as the `'splitTableCellVertically'`
- * and `'splitTableCellHorizontally'`  editor commands.
- *
- * You can split any cell vertically or horizontally by executing this command. For example, to split the selected table cell vertically:
- *
- * ```ts
- * editor.execute( 'splitTableCellVertically' );
- * ```
- */
-export default class SplitCellCommand extends Command {
-    /**
-     * The direction that indicates which cell will be split.
-     */
-    readonly direction: 'horizontally' | 'vertically';
-    /**
-     * Creates a new `SplitCellCommand` instance.
-     *
-     * @param editor The editor on which this command will be used.
-     * @param options.direction Indicates whether the command should split cells `'horizontally'` or `'vertically'`.
-     */
-    constructor(editor: Editor, options?: {
-        direction?: 'horizontally' | 'vertically';
-    });
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * @inheritDoc
-     */
-    execute(): void;
-}

package/dist/converters/downcast.d.ts

@@ -1,67 +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 type { Element, ElementCreatorFunction } from 'ckeditor5/src/engine.js';
-import type TableUtils from '../tableutils.js';
-import type { AdditionalSlot } from '../tableediting.js';
-/**
- * Model table element to view table element conversion helper.
- */
-export declare function downcastTable(tableUtils: TableUtils, options: DowncastTableOptions): ElementCreatorFunction;
-/**
- * Model table row element to view `<tr>` element conversion helper.
- *
- * @returns Element creator.
- */
-export declare function downcastRow(): ElementCreatorFunction;
-/**
- * Model table cell element to view `<td>` or `<th>` element conversion helper.
- *
- * This conversion helper will create proper `<th>` elements for table cells that are in the heading section (heading row or column)
- * and `<td>` otherwise.
- *
- * @param options.asWidget If set to `true`, the downcast conversion will produce a widget.
- * @returns Element creator.
- */
-export declare function downcastCell(options?: {
-    asWidget?: boolean;
-}): ElementCreatorFunction;
-/**
- * Overrides paragraph inside table cell conversion.
- *
- * This converter:
- * * should be used to override default paragraph conversion.
- * * It will only convert `<paragraph>` placed directly inside `<tableCell>`.
- * * For a single paragraph without attributes it returns `<span>` to simulate data table.
- * * For all other cases it returns `<p>` element.
- *
- * @param options.asWidget If set to `true`, the downcast conversion will produce a widget.
- * @returns Element creator.
- */
-export declare function convertParagraphInTableCell(options?: {
-    asWidget?: boolean;
-}): ElementCreatorFunction;
-/**
- * Checks if given model `<paragraph>` is an only child of a parent (`<tableCell>`) and if it has any attribute set.
- *
- * The paragraph should be converted in the editing view to:
- *
- * * If returned `true` - to a `<span class="ck-table-bogus-paragraph">`
- * * If returned `false` - to a `<p>`
- */
-export declare function isSingleParagraphWithoutAttributes(modelElement: Element): boolean;
-export interface DowncastTableOptions {
-    /**
-     * If set to `true`, the downcast conversion will produce a widget.
-     */
-    asWidget?: boolean;
-    /**
-     * Array of additional slot handlers.
-     */
-    additionalSlots: Array<AdditionalSlot>;
-}

package/dist/converters/table-caption-post-fixer.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/converters/table-caption-post-fixer
- */
-import type { Model } from 'ckeditor5/src/engine.js';
-/**
- * Injects a table caption post-fixer into the model.
- *
- * The role of the table caption post-fixer is to ensure that the table with caption have the correct structure
- * after a {@link module:engine/model/model~Model#change `change()`} block was executed.
- *
- * The correct structure means that:
- *
- * * If there are many caption model element, they are merged into one model.
- * * A final, merged caption model is placed at the end of the table.
- */
-export default function injectTableCaptionPostFixer(model: Model): void;

package/dist/converters/table-cell-paragraph-post-fixer.d.ts

@@ -1,36 +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/converters/table-cell-paragraph-post-fixer
- */
-import type { Model } from 'ckeditor5/src/engine.js';
-/**
- * Injects a table cell post-fixer into the model which inserts a `paragraph` element into empty table cells.
- *
- * A table cell must contain at least one block element as a child. An empty table cell will have an empty `paragraph` as a child.
- *
- * ```xml
- * <table>
- *   <tableRow>
- *      <tableCell></tableCell>
- *   </tableRow>
- * </table>
- * ```
- *
- * Will be fixed to:
- *
- * ```xml
- * <table>
- *   <tableRow>
- *      <tableCell><paragraph></paragraph></tableCell>
- *   </tableRow>
- * </table>
- * ```
- */
-export default function injectTableCellParagraphPostFixer(model: Model): void;

package/dist/converters/table-cell-refresh-handler.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/converters/table-cell-refresh-handler
- */
-import type { EditingController, Model } from 'ckeditor5/src/engine.js';
-/**
- * A table cell refresh handler which marks the table cell in the differ to have it re-rendered.
- *
- * Model `paragraph` inside a table cell can be rendered as `<span>` or `<p>`. It is rendered as `<span>` if this is the only block
- * element in that table cell and it does not have any attributes. It is rendered as `<p>` otherwise.
- *
- * When table cell content changes, for example a second `paragraph` element is added, we need to ensure that the first `paragraph` is
- * re-rendered so it changes from `<span>` to `<p>`. The easiest way to do it is to re-render the entire table cell.
- */
-export default function tableCellRefreshHandler(model: Model, editing: EditingController): void;

package/dist/converters/table-headings-refresh-handler.d.ts

@@ -1,21 +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/converters/table-headings-refresh-handler
- */
-import type { EditingController, Model } from 'ckeditor5/src/engine.js';
-/**
- * A table headings refresh handler which marks the table cells or rows in the differ to have it re-rendered
- * if the headings attribute changed.
- *
- * Table heading rows and heading columns are represented in the model by a `headingRows` and `headingColumns` attributes.
- *
- * When table headings attribute changes, all the cells/rows are marked to re-render to change between `<td>` and `<th>`.
- */
-export default function tableHeadingsRefreshHandler(model: Model, editing: EditingController): void;

package/dist/converters/table-layout-post-fixer.d.ts

@@ -1,230 +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/converters/table-layout-post-fixer
- */
-import type { Model } from 'ckeditor5/src/engine.js';
-/**
- * Injects a table layout post-fixer into the model.
- *
- * The role of the table layout post-fixer is to ensure that the table rows have the correct structure
- * after a {@link module:engine/model/model~Model#change `change()`} block was executed.
- *
- * The correct structure means that:
- *
- * * All table rows have the same size.
- * * None of the table cells extend vertically beyond their section (either header or body).
- * * A table cell has always at least one element as a child.
- *
- * If the table structure is not correct, the post-fixer will automatically correct it in two steps:
- *
- * 1. It will clip table cells that extend beyond their section.
- * 2. It will add empty table cells to the rows that are narrower than the widest table row.
- *
- * ## Clipping overlapping table cells
- *
- * Such situation may occur when pasting a table (or a part of a table) to the editor from external sources.
- *
- * For example, see the following table which has a cell (FOO) with the rowspan attribute (2):
- *
- * ```xml
- * <table headingRows="1">
- *   <tableRow>
- *     <tableCell rowspan="2"><paragraph>FOO</paragraph></tableCell>
- *     <tableCell colspan="2"><paragraph>BAR</paragraph></tableCell>
- *   </tableRow>
- *   <tableRow>
- *     <tableCell><paragraph>BAZ</paragraph></tableCell>
- *     <tableCell><paragraph>XYZ</paragraph></tableCell>
- *   </tableRow>
- * </table>
- * ```
- *
- * It will be rendered in the view as:
- *
- * ```xml
- * <table>
- *   <thead>
- *     <tr>
- *       <td rowspan="2">FOO</td>
- *       <td colspan="2">BAR</td>
- *     </tr>
- *   </thead>
- *   <tbody>
- *     <tr>
- *       <td>BAZ</td>
- *       <td>XYZ</td>
- *     </tr>
- *   </tbody>
- * </table>
- * ```
- *
- * In the above example the table will be rendered as a table with two rows: one in the header and second one in the body.
- * The table cell (FOO) cannot span over multiple rows as it would extend from the header to the body section.
- * The `rowspan` attribute must be changed to (1). The value (1) is the default value of the `rowspan` attribute
- * so the `rowspan` attribute will be removed from the model.
- *
- * The table cell with BAZ in the content will be in the first column of the table.
- *
- * ## Adding missing table cells
- *
- * The table post-fixer will insert empty table cells to equalize table row sizes (the number of columns).
- * The size of a table row is calculated by counting column spans of table cells, both horizontal (from the same row) and
- * vertical (from the rows above).
- *
- * In the above example, the table row in the body section of the table is narrower then the row from the header: it has two cells
- * with the default colspan (1). The header row has one cell with colspan (1) and the second with colspan (2).
- * The table cell (FOO) does not extend beyond the head section (and as such will be fixed in the first step of this post-fixer).
- * The post-fixer will add a missing table cell to the row in the body section of the table.
- *
- * The table from the above example will be fixed and rendered to the view as below:
- *
- * ```xml
- * <table>
- *   <thead>
- *     <tr>
- *       <td rowspan="2">FOO</td>
- *       <td colspan="2">BAR</td>
- *     </tr>
- *   </thead>
- *   <tbody>
- *     <tr>
- *       <td>BAZ</td>
- *       <td>XYZ</td>
- *     </tr>
- *   </tbody>
- * </table>
- * ```
- *
- * ## Collaboration and undo - Expectations vs post-fixer results
- *
- * The table post-fixer only ensures proper structure without a deeper analysis of the nature of the change. As such, it might lead
- * to a structure which was not intended by the user. In particular, it will also fix undo steps (in conjunction with collaboration)
- * in which the editor content might not return to the original state.
- *
- * This will usually happen when one or more users change the size of the table.
- *
- * As an example see the table below:
- *
- * ```xml
- * <table>
- *   <tbody>
- *     <tr>
- *       <td>11</td>
- *       <td>12</td>
- *     </tr>
- *     <tr>
- *       <td>21</td>
- *       <td>22</td>
- *     </tr>
- *   </tbody>
- * </table>
- * ```
- *
- * and the user actions:
- *
- * 1. Both users have a table with two rows and two columns.
- * 2. User A adds a column at the end of the table. This will insert empty table cells to two rows.
- * 3. User B adds a row at the end of the table. This will insert a row with two empty table cells.
- * 4. Both users will have a table as below:
- *
- * ```xml
- * <table>
- *   <tbody>
- *     <tr>
- *       <td>11</td>
- *       <td>12</td>
- *       <td>(empty, inserted by A)</td>
- *     </tr>
- *     <tr>
- *       <td>21</td>
- *       <td>22</td>
- *       <td>(empty, inserted by A)</td>
- *     </tr>
- *     <tr>
- *       <td>(empty, inserted by B)</td>
- *       <td>(empty, inserted by B)</td>
- *     </tr>
- *   </tbody>
- * </table>
- * ```
- *
- * The last row is shorter then others so the table post-fixer will add an empty row to the last row:
- *
- * ```xml
- * <table>
- *   <tbody>
- *     <tr>
- *       <td>11</td>
- *       <td>12</td>
- *       <td>(empty, inserted by A)</td>
- *     </tr>
- *     <tr>
- *       <td>21</td>
- *       <td>22</td>
- *       <td>(empty, inserted by A)</td>
- *     </tr>
- *     <tr>
- *       <td>(empty, inserted by B)</td>
- *       <td>(empty, inserted by B)</td>
- *       <td>(empty, inserted by the post-fixer)</td>
- *     </tr>
- *   </tbody>
- * </table>
- * ```
- *
- * Unfortunately undo does not know the nature of the changes and depending on which user applies the post-fixer changes, undoing them
- * might lead to a broken table. If User B undoes inserting the column to the table, the undo engine will undo only the operations of
- * inserting empty cells to rows from the initial table state (row 1 and 2) but the cell in the post-fixed row will remain:
- *
- * ```xml
- * <table>
- *   <tbody>
- *     <tr>
- *       <td>11</td>
- *       <td>12</td>
- *     </tr>
- *     <tr>
- *       <td>21</td>
- *       <td>22</td>
- *     </tr>
- *     <tr>
- *       <td>(empty, inserted by B)</td>
- *       <td>(empty, inserted by B)</td>
- *       <td>(empty, inserted by a post-fixer)</td>
- *     </tr>
- *   </tbody>
- * </table>
- * ```
- *
- * After undo, the table post-fixer will detect that two rows are shorter than others and will fix the table to:
- *
- * ```xml
- * <table>
- *   <tbody>
- *     <tr>
- *       <td>11</td>
- *       <td>12</td>
- *       <td>(empty, inserted by a post-fixer after undo)</td>
- *     </tr>
- *     <tr>
- *       <td>21</td>
- *       <td>22</td>
- *       <td>(empty, inserted by a post-fixer after undo)</td>
- *     </tr>
- *     <tr>
- *       <td>(empty, inserted by B)</td>
- *       <td>(empty, inserted by B)</td>
- *       <td>(empty, inserted by a post-fixer)</td>
- *     </tr>
- *   </tbody>
- * </table>
- * ```
- */
-export default function injectTableLayoutPostFixer(model: Model): void;

package/dist/converters/tableproperties.d.ts

@@ -1,58 +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/converters/tableproperties
- */
-import type { Conversion, ViewElement } from 'ckeditor5/src/engine.js';
-/**
- * Conversion helper for upcasting attributes using normalized styles.
- *
- * @param options.modelAttribute The attribute to set.
- * @param options.styleName The style name to convert.
- * @param options.viewElement The view element name that should be converted.
- * @param options.defaultValue The default value for the specified `modelAttribute`.
- * @param options.shouldUpcast The function which returns `true` if style should be upcasted from this element.
- */
-export declare function upcastStyleToAttribute(conversion: Conversion, options: {
-    modelAttribute: string;
-    styleName: string;
-    viewElement: string | RegExp;
-    defaultValue: string;
-    reduceBoxSides?: boolean;
-    shouldUpcast?: (viewElement: ViewElement) => boolean;
-}): void;
-export interface StyleValues {
-    color: string;
-    style: string;
-    width: string;
-}
-/**
- * Conversion helper for upcasting border styles for view elements.
- *
- * @param defaultBorder The default border values.
- * @param defaultBorder.color The default `borderColor` value.
- * @param defaultBorder.style The default `borderStyle` value.
- * @param defaultBorder.width The default `borderWidth` value.
- */
-export declare function upcastBorderStyles(conversion: Conversion, viewElementName: string, modelAttributes: StyleValues, defaultBorder: StyleValues): void;
-/**
- * Conversion helper for downcasting an attribute to a style.
- */
-export declare function downcastAttributeToStyle(conversion: Conversion, options: {
-    modelElement: string;
-    modelAttribute: string;
-    styleName: string;
-}): void;
-/**
- * Conversion helper for downcasting attributes from the model table to a view table (not to `<figure>`).
- */
-export declare function downcastTableAttribute(conversion: Conversion, options: {
-    modelAttribute: string;
-    styleName: string;
-}): void;

package/dist/converters/upcasttable.d.ts

@@ -1,53 +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/converters/upcasttable
- */
-import type { UpcastDispatcher } from 'ckeditor5/src/engine.js';
-/**
- * Returns a function that converts the table view representation:
- *
- * ```xml
- * <figure class="table"><table>...</table></figure>
- * ```
- *
- * to the model representation:
- *
- * ```xml
- * <table></table>
- * ```
- */
-export declare function upcastTableFigure(): (dispatcher: UpcastDispatcher) => void;
-/**
- * View table element to model table element conversion helper.
- *
- * This conversion helper converts the table element as well as table rows.
- *
- * @returns Conversion helper.
- */
-export default function upcastTable(): (dispatcher: UpcastDispatcher) => void;
-/**
- * A conversion helper that skips empty <tr> elements from upcasting at the beginning of the table.
- *
- * An empty row is considered a table model error but when handling clipboard data there could be rows that contain only row-spanned cells
- * and empty TR-s are used to maintain the table structure (also {@link module:table/tablewalker~TableWalker} assumes that there are only
- * rows that have related `tableRow` elements).
- *
- * *Note:* Only the first empty rows are removed because they have no meaning and it solves the issue
- * of an improper table with all empty rows.
- *
- * @returns Conversion helper.
- */
-export declare function skipEmptyTableRow(): (dispatcher: UpcastDispatcher) => void;
-/**
- * A converter that ensures an empty paragraph is inserted in a table cell if no other content was converted.
- *
- * @returns Conversion helper.
- */
-export declare function ensureParagraphInTableCell(elementName: string): (dispatcher: UpcastDispatcher) => void;