@ckeditor/ckeditor5-table 41.2.0 → 41.3.0-alpha.1

package/dist/types/converters/table-caption-post-fixer.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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
+ */
+/**
+ * @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/types/converters/table-cell-paragraph-post-fixer.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @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
+ */
+/**
+ * @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/types/converters/table-cell-refresh-handler.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @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
+ */
+/**
+ * @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/types/converters/table-headings-refresh-handler.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @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
+ */
+/**
+ * @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/types/converters/table-layout-post-fixer.d.ts

@@ -0,0 +1,226 @@
+/**
+ * @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
+ */
+/**
+ * @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/types/converters/tableproperties.d.ts

@@ -0,0 +1,54 @@
+/**
+ * @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
+ */
+/**
+ * @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/types/converters/upcasttable.d.ts

@@ -0,0 +1,49 @@
+/**
+ * @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
+ */
+/**
+ * @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;

package/dist/types/index.d.ts

@@ -0,0 +1,60 @@
+/**
+ * @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
+ */
+/**
+ * @module table
+ */
+export { default as PlainTableOutput } from './plaintableoutput.js';
+export { default as Table } from './table.js';
+export { default as TableEditing } from './tableediting.js';
+export { default as TableUI } from './tableui.js';
+export { default as TableToolbar } from './tabletoolbar.js';
+export { default as TableCellProperties } from './tablecellproperties.js';
+export { default as TableCellPropertiesEditing } from './tablecellproperties/tablecellpropertiesediting.js';
+export { default as TableCellPropertiesUI } from './tablecellproperties/tablecellpropertiesui.js';
+export { default as TableCellWidthEditing } from './tablecellwidth/tablecellwidthediting.js';
+export { default as TableProperties } from './tableproperties.js';
+export { default as TablePropertiesEditing } from './tableproperties/tablepropertiesediting.js';
+export { default as TablePropertiesUI } from './tableproperties/tablepropertiesui.js';
+export { default as TableCaption } from './tablecaption.js';
+export { default as TableCaptionEditing } from './tablecaption/tablecaptionediting.js';
+export { default as TableCaptionUI } from './tablecaption/tablecaptionui.js';
+export { default as TableClipboard } from './tableclipboard.js';
+export { default as TableMouse } from './tablemouse.js';
+export { default as TableKeyboard } from './tablekeyboard.js';
+export { default as TableSelection } from './tableselection.js';
+export { default as TableUtils } from './tableutils.js';
+export { default as TableColumnResize } from './tablecolumnresize.js';
+export { default as TableColumnResizeEditing } from './tablecolumnresize/tablecolumnresizeediting.js';
+export type { TableConfig } from './tableconfig.js';
+export type { default as InsertColumnCommand } from './commands/insertcolumncommand.js';
+export type { default as InsertRowCommand } from './commands/insertrowcommand.js';
+export type { default as InsertTableCommand } from './commands/inserttablecommand.js';
+export type { default as MergeCellCommand } from './commands/mergecellcommand.js';
+export type { default as MergeCellsCommand } from './commands/mergecellscommand.js';
+export type { default as RemoveColumnCommand } from './commands/removecolumncommand.js';
+export type { default as RemoveRowCommand } from './commands/removerowcommand.js';
+export type { default as SelectColumnCommand } from './commands/selectcolumncommand.js';
+export type { default as SelectRowCommand } from './commands/selectrowcommand.js';
+export type { default as SetHeaderColumnCommand } from './commands/setheadercolumncommand.js';
+export type { default as SetHeaderRowCommand } from './commands/setheaderrowcommand.js';
+export type { default as SplitCellCommand } from './commands/splitcellcommand.js';
+export type { default as ToggleTableCaptionCommand } from './tablecaption/toggletablecaptioncommand.js';
+export type { default as TableCellBackgroundColorCommand } from './tablecellproperties/commands/tablecellbackgroundcolorcommand.js';
+export type { default as TableCellBorderColorCommand } from './tablecellproperties/commands/tablecellbordercolorcommand.js';
+export type { default as TableCellBorderStyleCommand } from './tablecellproperties/commands/tablecellborderstylecommand.js';
+export type { default as TableCellBorderWidthCommand } from './tablecellproperties/commands/tablecellborderwidthcommand.js';
+export type { default as TableCellHeightCommand } from './tablecellproperties/commands/tablecellheightcommand.js';
+export type { default as TableCellHorizontalAlignmentCommand } from './tablecellproperties/commands/tablecellhorizontalalignmentcommand.js';
+export type { default as TableCellPaddingCommand } from './tablecellproperties/commands/tablecellpaddingcommand.js';
+export type { default as TableCellVerticalAlignmentCommand } from './tablecellproperties/commands/tablecellverticalalignmentcommand.js';
+export type { default as TableCellWidthCommand } from './tablecellwidth/commands/tablecellwidthcommand.js';
+export type { default as TableAlignmentCommand } from './tableproperties/commands/tablealignmentcommand.js';
+export type { default as TableBackgroundColorCommand } from './tableproperties/commands/tablebackgroundcolorcommand.js';
+export type { default as TableBorderColorCommand } from './tableproperties/commands/tablebordercolorcommand.js';
+export type { default as TableBorderStyleCommand } from './tableproperties/commands/tableborderstylecommand.js';
+export type { default as TableBorderWidthCommand } from './tableproperties/commands/tableborderwidthcommand.js';
+export type { default as TableHeightCommand } from './tableproperties/commands/tableheightcommand.js';
+export type { default as TableWidthCommand } from './tableproperties/commands/tablewidthcommand.js';
+import './augmentation.js';

package/dist/types/plaintableoutput.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @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
+ */
+/**
+ * @module table/plaintableoutput
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import Table from './table.js';
+/**
+ * The plain table output feature.
+ */
+export default class PlainTableOutput extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "PlainTableOutput";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof Table];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/dist/types/table.d.ts

@@ -0,0 +1,40 @@
+/**
+ * @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
+ */
+/**
+ * @module table/table
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { Widget } from 'ckeditor5/src/widget.js';
+import TableEditing from './tableediting.js';
+import TableUI from './tableui.js';
+import TableSelection from './tableselection.js';
+import TableClipboard from './tableclipboard.js';
+import TableKeyboard from './tablekeyboard.js';
+import TableMouse from './tablemouse.js';
+import '../theme/table.css';
+/**
+ * The table plugin.
+ *
+ * For a detailed overview, check the {@glink features/tables/tables Table feature documentation}.
+ *
+ * This is a "glue" plugin that loads the following table features:
+ *
+ * * {@link module:table/tableediting~TableEditing editing feature},
+ * * {@link module:table/tableselection~TableSelection selection feature},
+ * * {@link module:table/tablekeyboard~TableKeyboard keyboard navigation feature},
+ * * {@link module:table/tablemouse~TableMouse mouse selection feature},
+ * * {@link module:table/tableclipboard~TableClipboard clipboard feature},
+ * * {@link module:table/tableui~TableUI UI feature}.
+ */
+export default class Table extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TableEditing, typeof TableUI, typeof TableSelection, typeof TableMouse, typeof TableKeyboard, typeof TableClipboard, typeof Widget];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Table";
+}

package/dist/types/tablecaption/tablecaptionediting.d.ts

@@ -0,0 +1,63 @@
+/**
+ * @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
+ */
+/**
+ * @module table/tablecaption/tablecaptionediting
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core.js';
+import { Element } from 'ckeditor5/src/engine.js';
+/**
+ * The table caption editing plugin.
+ */
+export default class TableCaptionEditing extends Plugin {
+    /**
+     * A map that keeps saved JSONified table captions and table model elements they are
+     * associated with.
+     *
+     * To learn more about this system, see {@link #_saveCaption}.
+     */
+    private _savedCaptionsMap;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TableCaptionEditing";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Returns the saved {@link module:engine/model/element~Element#toJSON JSONified} caption
+     * of a table model element.
+     *
+     * See {@link #_saveCaption}.
+     *
+     * @internal
+     * @param tableModelElement The model element the caption should be returned for.
+     * @returns The model caption element or `null` if there is none.
+     */
+    _getSavedCaption(tableModelElement: Element): Element | null;
+    /**
+     * Saves a {@link module:engine/model/element~Element#toJSON JSONified} caption for
+     * a table element to allow restoring it in the future.
+     *
+     * A caption is saved every time it gets hidden. The
+     * user should be able to restore it on demand.
+     *
+     * **Note**: The caption cannot be stored in the table model element attribute because,
+     * for instance, when the model state propagates to collaborators, the attribute would get
+     * lost (mainly because it does not convert to anything when the caption is hidden) and
+     * the states of collaborators' models would de-synchronize causing numerous issues.
+     *
+     * See {@link #_getSavedCaption}.
+     *
+     * @internal
+     * @param tableModelElement The model element the caption is saved for.
+     * @param caption The caption model element to be saved.
+     */
+    _saveCaption(tableModelElement: Element, caption: Element): void;
+}

package/dist/types/tablecaption/tablecaptionui.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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
+ */
+/**
+* @module table/tablecaption/tablecaptionui
+*/
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+  * The table caption UI plugin. It introduces the `'toggleTableCaption'` UI button.
+  */
+export default class TableCaptionUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TableCaptionUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}