@ckeditor/ckeditor5-table 38.1.1 → 38.2.0-alpha.1

package/src/tablecaption/tablecaptionediting.d.ts

@@ -1,63 +1,63 @@
-/**
- * @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/tablecaptionediting
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-import { Element } from 'ckeditor5/src/engine';
-/**
- * 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;
-}
+/**
+ * @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/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/src/tablecaption/tablecaptionediting.js

@@ -1,122 +1,122 @@
-/**
- * @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/tablecaptionediting
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Element, enablePlaceholder } from 'ckeditor5/src/engine';
-import { toWidgetEditable } from 'ckeditor5/src/widget';
-import injectTableCaptionPostFixer from '../converters/table-caption-post-fixer';
-import ToggleTableCaptionCommand from './toggletablecaptioncommand';
-import { isTable, matchTableCaptionViewElement } from './utils';
-/**
- * The table caption editing plugin.
- */
-export default class TableCaptionEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'TableCaptionEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        this._savedCaptionsMap = new WeakMap();
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const schema = editor.model.schema;
-        const view = editor.editing.view;
-        const t = editor.t;
-        if (!schema.isRegistered('caption')) {
-            schema.register('caption', {
-                allowIn: 'table',
-                allowContentOf: '$block',
-                isLimit: true
-            });
-        }
-        else {
-            schema.extend('caption', {
-                allowIn: 'table'
-            });
-        }
-        editor.commands.add('toggleTableCaption', new ToggleTableCaptionCommand(this.editor));
-        // View -> model converter for the data pipeline.
-        editor.conversion.for('upcast').elementToElement({
-            view: matchTableCaptionViewElement,
-            model: 'caption'
-        });
-        // Model -> view converter for the data pipeline.
-        editor.conversion.for('dataDowncast').elementToElement({
-            model: 'caption',
-            view: (modelElement, { writer }) => {
-                if (!isTable(modelElement.parent)) {
-                    return null;
-                }
-                return writer.createContainerElement('figcaption');
-            }
-        });
-        // Model -> view converter for the editing pipeline.
-        editor.conversion.for('editingDowncast').elementToElement({
-            model: 'caption',
-            view: (modelElement, { writer }) => {
-                if (!isTable(modelElement.parent)) {
-                    return null;
-                }
-                const figcaptionElement = writer.createEditableElement('figcaption');
-                writer.setCustomProperty('tableCaption', true, figcaptionElement);
-                enablePlaceholder({
-                    view,
-                    element: figcaptionElement,
-                    text: t('Enter table caption'),
-                    keepOnFocus: true
-                });
-                return toWidgetEditable(figcaptionElement, writer);
-            }
-        });
-        injectTableCaptionPostFixer(editor.model);
-    }
-    /**
-     * 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) {
-        const jsonObject = this._savedCaptionsMap.get(tableModelElement);
-        return jsonObject ? Element.fromJSON(jsonObject) : 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, caption) {
-        this._savedCaptionsMap.set(tableModelElement, caption.toJSON());
-    }
-}
+/**
+ * @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/tablecaptionediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { Element, enablePlaceholder } from 'ckeditor5/src/engine.js';
+import { toWidgetEditable } from 'ckeditor5/src/widget.js';
+import injectTableCaptionPostFixer from '../converters/table-caption-post-fixer.js';
+import ToggleTableCaptionCommand from './toggletablecaptioncommand.js';
+import { isTable, matchTableCaptionViewElement } from './utils.js';
+/**
+ * The table caption editing plugin.
+ */
+export default class TableCaptionEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'TableCaptionEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        this._savedCaptionsMap = new WeakMap();
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const schema = editor.model.schema;
+        const view = editor.editing.view;
+        const t = editor.t;
+        if (!schema.isRegistered('caption')) {
+            schema.register('caption', {
+                allowIn: 'table',
+                allowContentOf: '$block',
+                isLimit: true
+            });
+        }
+        else {
+            schema.extend('caption', {
+                allowIn: 'table'
+            });
+        }
+        editor.commands.add('toggleTableCaption', new ToggleTableCaptionCommand(this.editor));
+        // View -> model converter for the data pipeline.
+        editor.conversion.for('upcast').elementToElement({
+            view: matchTableCaptionViewElement,
+            model: 'caption'
+        });
+        // Model -> view converter for the data pipeline.
+        editor.conversion.for('dataDowncast').elementToElement({
+            model: 'caption',
+            view: (modelElement, { writer }) => {
+                if (!isTable(modelElement.parent)) {
+                    return null;
+                }
+                return writer.createContainerElement('figcaption');
+            }
+        });
+        // Model -> view converter for the editing pipeline.
+        editor.conversion.for('editingDowncast').elementToElement({
+            model: 'caption',
+            view: (modelElement, { writer }) => {
+                if (!isTable(modelElement.parent)) {
+                    return null;
+                }
+                const figcaptionElement = writer.createEditableElement('figcaption');
+                writer.setCustomProperty('tableCaption', true, figcaptionElement);
+                enablePlaceholder({
+                    view,
+                    element: figcaptionElement,
+                    text: t('Enter table caption'),
+                    keepOnFocus: true
+                });
+                return toWidgetEditable(figcaptionElement, writer);
+            }
+        });
+        injectTableCaptionPostFixer(editor.model);
+    }
+    /**
+     * 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) {
+        const jsonObject = this._savedCaptionsMap.get(tableModelElement);
+        return jsonObject ? Element.fromJSON(jsonObject) : 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, caption) {
+        this._savedCaptionsMap.set(tableModelElement, caption.toJSON());
+    }
+}

package/src/tablecaption/tablecaptionui.d.ts

@@ -1,21 +1,21 @@
-/**
- * @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/tablecaptionui
-*/
-import { Plugin } from 'ckeditor5/src/core';
-/**
-  * 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;
-}
+/**
+ * @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/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;
+}

package/src/tablecaption/tablecaptionui.js

@@ -1,57 +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
- */
-/**
-* @module table/tablecaption/tablecaptionui
-*/
-import { Plugin, icons } from 'ckeditor5/src/core';
-import { ButtonView } from 'ckeditor5/src/ui';
-import { getCaptionFromModelSelection } from './utils';
-/**
-  * The table caption UI plugin. It introduces the `'toggleTableCaption'` UI button.
-  */
-export default class TableCaptionUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'TableCaptionUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const editingView = editor.editing.view;
-        const t = editor.t;
-        editor.ui.componentFactory.add('toggleTableCaption', locale => {
-            const command = editor.commands.get('toggleTableCaption');
-            const view = new ButtonView(locale);
-            view.set({
-                icon: icons.caption,
-                tooltip: true,
-                isToggleable: true
-            });
-            view.bind('isOn', 'isEnabled').to(command, 'value', 'isEnabled');
-            view.bind('label').to(command, 'value', value => value ? t('Toggle caption off') : t('Toggle caption on'));
-            this.listenTo(view, 'execute', () => {
-                editor.execute('toggleTableCaption', { focusCaptionOnShow: true });
-                // Scroll to the selection and highlight the caption if the caption showed up.
-                if (command.value) {
-                    const modelCaptionElement = getCaptionFromModelSelection(editor.model.document.selection);
-                    const figcaptionElement = editor.editing.mapper.toViewElement(modelCaptionElement);
-                    if (!figcaptionElement) {
-                        return;
-                    }
-                    editingView.scrollToTheSelection();
-                    editingView.change(writer => {
-                        writer.addClass('table__caption_highlighted', figcaptionElement);
-                    });
-                }
-                editor.editing.view.focus();
-            });
-            return view;
-        });
-    }
-}
+/**
+ * @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/tablecaptionui
+*/
+import { Plugin, icons } from 'ckeditor5/src/core.js';
+import { ButtonView } from 'ckeditor5/src/ui.js';
+import { getCaptionFromModelSelection } from './utils.js';
+/**
+  * The table caption UI plugin. It introduces the `'toggleTableCaption'` UI button.
+  */
+export default class TableCaptionUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'TableCaptionUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const editingView = editor.editing.view;
+        const t = editor.t;
+        editor.ui.componentFactory.add('toggleTableCaption', locale => {
+            const command = editor.commands.get('toggleTableCaption');
+            const view = new ButtonView(locale);
+            view.set({
+                icon: icons.caption,
+                tooltip: true,
+                isToggleable: true
+            });
+            view.bind('isOn', 'isEnabled').to(command, 'value', 'isEnabled');
+            view.bind('label').to(command, 'value', value => value ? t('Toggle caption off') : t('Toggle caption on'));
+            this.listenTo(view, 'execute', () => {
+                editor.execute('toggleTableCaption', { focusCaptionOnShow: true });
+                // Scroll to the selection and highlight the caption if the caption showed up.
+                if (command.value) {
+                    const modelCaptionElement = getCaptionFromModelSelection(editor.model.document.selection);
+                    const figcaptionElement = editor.editing.mapper.toViewElement(modelCaptionElement);
+                    if (!figcaptionElement) {
+                        return;
+                    }
+                    editingView.scrollToTheSelection();
+                    editingView.change(writer => {
+                        writer.addClass('table__caption_highlighted', figcaptionElement);
+                    });
+                }
+                editor.editing.view.focus();
+            });
+            return view;
+        });
+    }
+}