@ckeditor/ckeditor5-table 40.0.0 → 40.2.0

package/src/tablecaption/toggletablecaptioncommand.d.ts

@@ -1,68 +1,68 @@
-/**
- * @license Copyright (c) 2003-2023, 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/toggletablecaptioncommand
-*/
-import { Command } from 'ckeditor5/src/core';
-/**
- * The toggle table caption command.
- *
- * This command is registered by {@link module:table/tablecaption/tablecaptionediting~TableCaptionEditing} as the
- * `'toggleTableCaption'` editor command.
- *
- * Executing this command:
- *
- * * either adds or removes the table caption of a selected table (depending on whether the caption is present or not),
- * * removes the table caption if the selection is anchored in one.
- *
- * ```ts
- * // Toggle the presence of the caption.
- * editor.execute( 'toggleTableCaption' );
- * ```
- *
- * **Note**: You can move the selection to the caption right away as it shows up upon executing this command by using
- * the `focusCaptionOnShow` option:
- *
- * ```ts
- * editor.execute( 'toggleTableCaption', { focusCaptionOnShow: true } );
- * ```
- */
-export default class ToggleTableCaptionCommand extends Command {
-    value: boolean;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * ```ts
-     * editor.execute( 'toggleTableCaption' );
-     * ```
-     *
-     * @param options Options for the executed command.
-     * @param options.focusCaptionOnShow When true and the caption shows up, the selection will be moved into it straight away.
-     * @fires execute
-     */
-    execute({ focusCaptionOnShow }?: {
-        focusCaptionOnShow?: boolean;
-    }): void;
-    /**
-     * Shows the table caption. Also:
-     *
-     * * it attempts to restore the caption content from the `TableCaptionEditing` caption registry,
-     * * it moves the selection to the caption right away, it the `focusCaptionOnShow` option was set.
-     *
-     * @param focusCaptionOnShow Default focus behavior when showing the caption.
-     */
-    private _showTableCaption;
-    /**
-     * Hides the caption of a selected table (or an table caption the selection is anchored to).
-     *
-     * The content of the caption is stored in the `TableCaptionEditing` caption registry to make this
-     * a reversible action.
-     */
-    private _hideTableCaption;
-}
+/**
+ * @license Copyright (c) 2003-2023, 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/toggletablecaptioncommand
+*/
+import { Command } from 'ckeditor5/src/core';
+/**
+ * The toggle table caption command.
+ *
+ * This command is registered by {@link module:table/tablecaption/tablecaptionediting~TableCaptionEditing} as the
+ * `'toggleTableCaption'` editor command.
+ *
+ * Executing this command:
+ *
+ * * either adds or removes the table caption of a selected table (depending on whether the caption is present or not),
+ * * removes the table caption if the selection is anchored in one.
+ *
+ * ```ts
+ * // Toggle the presence of the caption.
+ * editor.execute( 'toggleTableCaption' );
+ * ```
+ *
+ * **Note**: You can move the selection to the caption right away as it shows up upon executing this command by using
+ * the `focusCaptionOnShow` option:
+ *
+ * ```ts
+ * editor.execute( 'toggleTableCaption', { focusCaptionOnShow: true } );
+ * ```
+ */
+export default class ToggleTableCaptionCommand extends Command {
+    value: boolean;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * ```ts
+     * editor.execute( 'toggleTableCaption' );
+     * ```
+     *
+     * @param options Options for the executed command.
+     * @param options.focusCaptionOnShow When true and the caption shows up, the selection will be moved into it straight away.
+     * @fires execute
+     */
+    execute({ focusCaptionOnShow }?: {
+        focusCaptionOnShow?: boolean;
+    }): void;
+    /**
+     * Shows the table caption. Also:
+     *
+     * * it attempts to restore the caption content from the `TableCaptionEditing` caption registry,
+     * * it moves the selection to the caption right away, it the `focusCaptionOnShow` option was set.
+     *
+     * @param focusCaptionOnShow Default focus behavior when showing the caption.
+     */
+    private _showTableCaption;
+    /**
+     * Hides the caption of a selected table (or an table caption the selection is anchored to).
+     *
+     * The content of the caption is stored in the `TableCaptionEditing` caption registry to make this
+     * a reversible action.
+     */
+    private _hideTableCaption;
+}

package/src/tablecaption/toggletablecaptioncommand.js

@@ -1,104 +1,105 @@
-/**
- * @license Copyright (c) 2003-2023, 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/toggletablecaptioncommand
-*/
-import { Command } from 'ckeditor5/src/core';
-import { getCaptionFromTableModelElement, getSelectionAffectedTable } from './utils';
-/**
- * The toggle table caption command.
- *
- * This command is registered by {@link module:table/tablecaption/tablecaptionediting~TableCaptionEditing} as the
- * `'toggleTableCaption'` editor command.
- *
- * Executing this command:
- *
- * * either adds or removes the table caption of a selected table (depending on whether the caption is present or not),
- * * removes the table caption if the selection is anchored in one.
- *
- * ```ts
- * // Toggle the presence of the caption.
- * editor.execute( 'toggleTableCaption' );
- * ```
- *
- * **Note**: You can move the selection to the caption right away as it shows up upon executing this command by using
- * the `focusCaptionOnShow` option:
- *
- * ```ts
- * editor.execute( 'toggleTableCaption', { focusCaptionOnShow: true } );
- * ```
- */
-export default class ToggleTableCaptionCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    refresh() {
-        const editor = this.editor;
-        const tableElement = getSelectionAffectedTable(editor.model.document.selection);
-        this.isEnabled = !!tableElement;
-        if (!this.isEnabled) {
-            this.value = false;
-        }
-        else {
-            this.value = !!getCaptionFromTableModelElement(tableElement);
-        }
-    }
-    /**
-     * Executes the command.
-     *
-     * ```ts
-     * editor.execute( 'toggleTableCaption' );
-     * ```
-     *
-     * @param options Options for the executed command.
-     * @param options.focusCaptionOnShow When true and the caption shows up, the selection will be moved into it straight away.
-     * @fires execute
-     */
-    execute({ focusCaptionOnShow = false } = {}) {
-        this.editor.model.change(writer => {
-            if (this.value) {
-                this._hideTableCaption(writer);
-            }
-            else {
-                this._showTableCaption(writer, focusCaptionOnShow);
-            }
-        });
-    }
-    /**
-     * Shows the table caption. Also:
-     *
-     * * it attempts to restore the caption content from the `TableCaptionEditing` caption registry,
-     * * it moves the selection to the caption right away, it the `focusCaptionOnShow` option was set.
-     *
-     * @param focusCaptionOnShow Default focus behavior when showing the caption.
-     */
-    _showTableCaption(writer, focusCaptionOnShow) {
-        const model = this.editor.model;
-        const tableElement = getSelectionAffectedTable(model.document.selection);
-        const tableCaptionEditing = this.editor.plugins.get('TableCaptionEditing');
-        const savedCaptionElement = tableCaptionEditing._getSavedCaption(tableElement);
-        // Try restoring the caption from the TableCaptionEditing plugin storage.
-        const newCaptionElement = savedCaptionElement || writer.createElement('caption');
-        model.insertContent(newCaptionElement, tableElement, 'end');
-        if (focusCaptionOnShow) {
-            writer.setSelection(newCaptionElement, 'in');
-        }
-    }
-    /**
-     * Hides the caption of a selected table (or an table caption the selection is anchored to).
-     *
-     * The content of the caption is stored in the `TableCaptionEditing` caption registry to make this
-     * a reversible action.
-     */
-    _hideTableCaption(writer) {
-        const model = this.editor.model;
-        const tableElement = getSelectionAffectedTable(model.document.selection);
-        const tableCaptionEditing = this.editor.plugins.get('TableCaptionEditing');
-        const captionElement = getCaptionFromTableModelElement(tableElement);
-        // Store the caption content so it can be restored quickly if the user changes their mind.
-        tableCaptionEditing._saveCaption(tableElement, captionElement);
-        model.deleteContent(writer.createSelection(captionElement, 'on'));
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, 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/toggletablecaptioncommand
+*/
+import { Command } from 'ckeditor5/src/core';
+import { getCaptionFromTableModelElement } from './utils';
+import { getSelectionAffectedTable } from '../utils/common';
+/**
+ * The toggle table caption command.
+ *
+ * This command is registered by {@link module:table/tablecaption/tablecaptionediting~TableCaptionEditing} as the
+ * `'toggleTableCaption'` editor command.
+ *
+ * Executing this command:
+ *
+ * * either adds or removes the table caption of a selected table (depending on whether the caption is present or not),
+ * * removes the table caption if the selection is anchored in one.
+ *
+ * ```ts
+ * // Toggle the presence of the caption.
+ * editor.execute( 'toggleTableCaption' );
+ * ```
+ *
+ * **Note**: You can move the selection to the caption right away as it shows up upon executing this command by using
+ * the `focusCaptionOnShow` option:
+ *
+ * ```ts
+ * editor.execute( 'toggleTableCaption', { focusCaptionOnShow: true } );
+ * ```
+ */
+export default class ToggleTableCaptionCommand extends Command {
+    /**
+     * @inheritDoc
+     */
+    refresh() {
+        const editor = this.editor;
+        const tableElement = getSelectionAffectedTable(editor.model.document.selection);
+        this.isEnabled = !!tableElement;
+        if (!this.isEnabled) {
+            this.value = false;
+        }
+        else {
+            this.value = !!getCaptionFromTableModelElement(tableElement);
+        }
+    }
+    /**
+     * Executes the command.
+     *
+     * ```ts
+     * editor.execute( 'toggleTableCaption' );
+     * ```
+     *
+     * @param options Options for the executed command.
+     * @param options.focusCaptionOnShow When true and the caption shows up, the selection will be moved into it straight away.
+     * @fires execute
+     */
+    execute({ focusCaptionOnShow = false } = {}) {
+        this.editor.model.change(writer => {
+            if (this.value) {
+                this._hideTableCaption(writer);
+            }
+            else {
+                this._showTableCaption(writer, focusCaptionOnShow);
+            }
+        });
+    }
+    /**
+     * Shows the table caption. Also:
+     *
+     * * it attempts to restore the caption content from the `TableCaptionEditing` caption registry,
+     * * it moves the selection to the caption right away, it the `focusCaptionOnShow` option was set.
+     *
+     * @param focusCaptionOnShow Default focus behavior when showing the caption.
+     */
+    _showTableCaption(writer, focusCaptionOnShow) {
+        const model = this.editor.model;
+        const tableElement = getSelectionAffectedTable(model.document.selection);
+        const tableCaptionEditing = this.editor.plugins.get('TableCaptionEditing');
+        const savedCaptionElement = tableCaptionEditing._getSavedCaption(tableElement);
+        // Try restoring the caption from the TableCaptionEditing plugin storage.
+        const newCaptionElement = savedCaptionElement || writer.createElement('caption');
+        model.insertContent(newCaptionElement, tableElement, 'end');
+        if (focusCaptionOnShow) {
+            writer.setSelection(newCaptionElement, 'in');
+        }
+    }
+    /**
+     * Hides the caption of a selected table (or an table caption the selection is anchored to).
+     *
+     * The content of the caption is stored in the `TableCaptionEditing` caption registry to make this
+     * a reversible action.
+     */
+    _hideTableCaption(writer) {
+        const model = this.editor.model;
+        const tableElement = getSelectionAffectedTable(model.document.selection);
+        const tableCaptionEditing = this.editor.plugins.get('TableCaptionEditing');
+        const captionElement = getCaptionFromTableModelElement(tableElement);
+        // Store the caption content so it can be restored quickly if the user changes their mind.
+        tableCaptionEditing._saveCaption(tableElement, captionElement);
+        model.deleteContent(writer.createSelection(captionElement, 'on'));
+    }
+}

package/src/tablecaption/utils.d.ts

@@ -1,42 +1,38 @@
-/**
- * @license Copyright (c) 2003-2023, 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/utils
- */
-import type { DocumentFragment, DocumentSelection, Element, ViewElement } from 'ckeditor5/src/engine';
-/**
- * Checks if the provided model element is a `table`.
- *
- * @param modelElement Element to check if it is a table.
- */
-export declare function isTable(modelElement: Element | DocumentFragment | null): boolean;
-/**
- * Returns the caption model element from a given table element. Returns `null` if no caption is found.
- *
- * @param tableModelElement Table element in which we will try to find a caption element.
- */
-export declare function getCaptionFromTableModelElement(tableModelElement: Element): Element | null;
-/**
- * Returns the caption model element for a model selection. Returns `null` if the selection has no caption element ancestor.
- *
- * @param selection The selection checked for caption presence.
- */
-export declare function getCaptionFromModelSelection(selection: DocumentSelection): Element | null;
-/**
- * {@link module:engine/view/matcher~Matcher} pattern. Checks if a given element is a caption.
- *
- * There are two possible forms of the valid caption:
- *  - A `<figcaption>` element inside a `<figure class="table">` element.
- *  - A `<caption>` inside a <table>.
- *
- * @returns Returns the object accepted by {@link module:engine/view/matcher~Matcher} or `null` if the element cannot be matched.
- */
-export declare function matchTableCaptionViewElement(element: ViewElement): {
-    name: true;
-} | null;
-/**
- * Depending on the position of the selection we either return the table under cursor or look for the table higher in the hierarchy.
- */
-export declare function getSelectionAffectedTable(selection: DocumentSelection): Element;
+/**
+ * @license Copyright (c) 2003-2023, 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/utils
+ */
+import type { DocumentFragment, DocumentSelection, Element, ViewElement } from 'ckeditor5/src/engine';
+/**
+ * Checks if the provided model element is a `table`.
+ *
+ * @param modelElement Element to check if it is a table.
+ */
+export declare function isTable(modelElement: Element | DocumentFragment | null): boolean;
+/**
+ * Returns the caption model element from a given table element. Returns `null` if no caption is found.
+ *
+ * @param tableModelElement Table element in which we will try to find a caption element.
+ */
+export declare function getCaptionFromTableModelElement(tableModelElement: Element): Element | null;
+/**
+ * Returns the caption model element for a model selection. Returns `null` if the selection has no caption element ancestor.
+ *
+ * @param selection The selection checked for caption presence.
+ */
+export declare function getCaptionFromModelSelection(selection: DocumentSelection): Element | null;
+/**
+ * {@link module:engine/view/matcher~Matcher} pattern. Checks if a given element is a caption.
+ *
+ * There are two possible forms of the valid caption:
+ *  - A `<figcaption>` element inside a `<figure class="table">` element.
+ *  - A `<caption>` inside a <table>.
+ *
+ * @returns Returns the object accepted by {@link module:engine/view/matcher~Matcher} or `null` if the element cannot be matched.
+ */
+export declare function matchTableCaptionViewElement(element: ViewElement): {
+    name: true;
+} | null;

package/src/tablecaption/utils.js

@@ -1,67 +1,57 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * Checks if the provided model element is a `table`.
- *
- * @param modelElement Element to check if it is a table.
- */
-export function isTable(modelElement) {
-    return !!modelElement && modelElement.is('element', 'table');
-}
-/**
- * Returns the caption model element from a given table element. Returns `null` if no caption is found.
- *
- * @param tableModelElement Table element in which we will try to find a caption element.
- */
-export function getCaptionFromTableModelElement(tableModelElement) {
-    for (const node of tableModelElement.getChildren()) {
-        if (node.is('element', 'caption')) {
-            return node;
-        }
-    }
-    return null;
-}
-/**
- * Returns the caption model element for a model selection. Returns `null` if the selection has no caption element ancestor.
- *
- * @param selection The selection checked for caption presence.
- */
-export function getCaptionFromModelSelection(selection) {
-    const tableElement = getSelectionAffectedTable(selection);
-    if (!tableElement) {
-        return null;
-    }
-    return getCaptionFromTableModelElement(tableElement);
-}
-/**
- * {@link module:engine/view/matcher~Matcher} pattern. Checks if a given element is a caption.
- *
- * There are two possible forms of the valid caption:
- *  - A `<figcaption>` element inside a `<figure class="table">` element.
- *  - A `<caption>` inside a <table>.
- *
- * @returns Returns the object accepted by {@link module:engine/view/matcher~Matcher} or `null` if the element cannot be matched.
- */
-export function matchTableCaptionViewElement(element) {
-    const parent = element.parent;
-    if (element.name == 'figcaption' && parent && parent.is('element', 'figure') && parent.hasClass('table')) {
-        return { name: true };
-    }
-    if (element.name == 'caption' && parent && parent.is('element', 'table')) {
-        return { name: true };
-    }
-    return null;
-}
-/**
- * Depending on the position of the selection we either return the table under cursor or look for the table higher in the hierarchy.
- */
-export function getSelectionAffectedTable(selection) {
-    const selectedElement = selection.getSelectedElement();
-    // Is the command triggered from the `tableToolbar`?
-    if (selectedElement && selectedElement.is('element', 'table')) {
-        return selectedElement;
-    }
-    return selection.getFirstPosition().findAncestor('table');
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { getSelectionAffectedTable } from '../utils/common';
+/**
+ * Checks if the provided model element is a `table`.
+ *
+ * @param modelElement Element to check if it is a table.
+ */
+export function isTable(modelElement) {
+    return !!modelElement && modelElement.is('element', 'table');
+}
+/**
+ * Returns the caption model element from a given table element. Returns `null` if no caption is found.
+ *
+ * @param tableModelElement Table element in which we will try to find a caption element.
+ */
+export function getCaptionFromTableModelElement(tableModelElement) {
+    for (const node of tableModelElement.getChildren()) {
+        if (node.is('element', 'caption')) {
+            return node;
+        }
+    }
+    return null;
+}
+/**
+ * Returns the caption model element for a model selection. Returns `null` if the selection has no caption element ancestor.
+ *
+ * @param selection The selection checked for caption presence.
+ */
+export function getCaptionFromModelSelection(selection) {
+    const tableElement = getSelectionAffectedTable(selection);
+    if (!tableElement) {
+        return null;
+    }
+    return getCaptionFromTableModelElement(tableElement);
+}
+/**
+ * {@link module:engine/view/matcher~Matcher} pattern. Checks if a given element is a caption.
+ *
+ * There are two possible forms of the valid caption:
+ *  - A `<figcaption>` element inside a `<figure class="table">` element.
+ *  - A `<caption>` inside a <table>.
+ *
+ * @returns Returns the object accepted by {@link module:engine/view/matcher~Matcher} or `null` if the element cannot be matched.
+ */
+export function matchTableCaptionViewElement(element) {
+    const parent = element.parent;
+    if (element.name == 'figcaption' && parent && parent.is('element', 'figure') && parent.hasClass('table')) {
+        return { name: true };
+    }
+    if (element.name == 'caption' && parent && parent.is('element', 'table')) {
+        return { name: true };
+    }
+    return null;
+}

package/src/tablecaption.d.ts

@@ -1,24 +1,24 @@
-/**
- * @license Copyright (c) 2003-2023, 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
- */
-import { Plugin } from 'ckeditor5/src/core';
-import TableCaptionEditing from './tablecaption/tablecaptionediting';
-import TableCaptionUI from './tablecaption/tablecaptionui';
-import '../theme/tablecaption.css';
-/**
- * The table caption plugin.
- */
-export default class TableCaption extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TableCaption";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof TableCaptionEditing, typeof TableCaptionUI];
-}
+/**
+ * @license Copyright (c) 2003-2023, 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
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import TableCaptionEditing from './tablecaption/tablecaptionediting';
+import TableCaptionUI from './tablecaption/tablecaptionui';
+import '../theme/tablecaption.css';
+/**
+ * The table caption plugin.
+ */
+export default class TableCaption extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "TableCaption";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof TableCaptionEditing, typeof TableCaptionUI];
+}