@ckeditor/ckeditor5-image 40.0.0 → 40.2.0

package/src/imageconfig.js

@@ -1,5 +1,5 @@
-/**
- * @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
- */
-export {};
+/**
+ * @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
+ */
+export {};

package/src/imageinline.d.ts

@@ -1,33 +1,34 @@
-/**
- * @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 image/imageinline
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Widget } from 'ckeditor5/src/widget';
-import ImageTextAlternative from './imagetextalternative';
-import ImageInlineEditing from './image/imageinlineediting';
-import '../theme/image.css';
-/**
- * The image inline plugin.
- *
- * This is a "glue" plugin which loads the following plugins:
- *
- * * {@link module:image/image/imageinlineediting~ImageInlineEditing},
- * * {@link module:image/imagetextalternative~ImageTextAlternative}.
- *
- * Usually, it is used in conjunction with other plugins from this package. See the {@glink api/image package page}
- * for more information.
- */
-export default class ImageInline extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageInlineEditing, typeof Widget, typeof ImageTextAlternative];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageInline";
-}
+/**
+ * @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 image/imageinline
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Widget } from 'ckeditor5/src/widget';
+import ImageTextAlternative from './imagetextalternative';
+import ImageInlineEditing from './image/imageinlineediting';
+import ImageInsertUI from './imageinsert/imageinsertui';
+import '../theme/image.css';
+/**
+ * The image inline plugin.
+ *
+ * This is a "glue" plugin which loads the following plugins:
+ *
+ * * {@link module:image/image/imageinlineediting~ImageInlineEditing},
+ * * {@link module:image/imagetextalternative~ImageTextAlternative}.
+ *
+ * Usually, it is used in conjunction with other plugins from this package. See the {@glink api/image package page}
+ * for more information.
+ */
+export default class ImageInline extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageInlineEditing, typeof Widget, typeof ImageTextAlternative, typeof ImageInsertUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageInline";
+}

package/src/imageinline.js

@@ -1,37 +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 image/imageinline
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Widget } from 'ckeditor5/src/widget';
-import ImageTextAlternative from './imagetextalternative';
-import ImageInlineEditing from './image/imageinlineediting';
-import '../theme/image.css';
-/**
- * The image inline plugin.
- *
- * This is a "glue" plugin which loads the following plugins:
- *
- * * {@link module:image/image/imageinlineediting~ImageInlineEditing},
- * * {@link module:image/imagetextalternative~ImageTextAlternative}.
- *
- * Usually, it is used in conjunction with other plugins from this package. See the {@glink api/image package page}
- * for more information.
- */
-export default class ImageInline extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [ImageInlineEditing, Widget, ImageTextAlternative];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'ImageInline';
-    }
-}
+/**
+ * @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 image/imageinline
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Widget } from 'ckeditor5/src/widget';
+import ImageTextAlternative from './imagetextalternative';
+import ImageInlineEditing from './image/imageinlineediting';
+import ImageInsertUI from './imageinsert/imageinsertui';
+import '../theme/image.css';
+/**
+ * The image inline plugin.
+ *
+ * This is a "glue" plugin which loads the following plugins:
+ *
+ * * {@link module:image/image/imageinlineediting~ImageInlineEditing},
+ * * {@link module:image/imagetextalternative~ImageTextAlternative}.
+ *
+ * Usually, it is used in conjunction with other plugins from this package. See the {@glink api/image package page}
+ * for more information.
+ */
+export default class ImageInline extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ImageInlineEditing, Widget, ImageTextAlternative, ImageInsertUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ImageInline';
+    }
+}

package/src/imageinsert/imageinsertui.d.ts

@@ -1,44 +1,72 @@
-/**
- * @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 image/imageinsert/imageinsertui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { type DropdownView } from 'ckeditor5/src/ui';
-/**
- * The image insert dropdown plugin.
- *
- * For a detailed overview, check the {@glink features/images/image-upload/image-upload Image upload feature}
- * and {@glink features/images/images-inserting Insert images via source URL} documentation.
- *
- * Adds the `'insertImage'` dropdown to the {@link module:ui/componentfactory~ComponentFactory UI component factory}
- * and also the `imageInsert` dropdown as an alias for backward compatibility.
- */
-export default class ImageInsertUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageInsertUI";
-    /**
-     * The dropdown view responsible for displaying the image insert UI.
-     */
-    dropdownView?: DropdownView;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Creates the dropdown view.
-     *
-     * @param locale The localization services instance.
-     */
-    private _createDropdownView;
-    /**
-     * Sets up the dropdown view.
-     *
-     * @param command An uploadImage or insertImage command.
-     */
-    private _setUpDropdown;
-}
+/**
+ * @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 image/imageinsert/imageinsertui
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+import { type Observable } from 'ckeditor5/src/utils';
+import { type ButtonView, type DropdownView, type FocusableView } from 'ckeditor5/src/ui';
+import ImageUtils from '../imageutils';
+/**
+ * The image insert dropdown plugin.
+ *
+ * For a detailed overview, check the {@glink features/images/image-upload/image-upload Image upload feature}
+ * and {@glink features/images/images-inserting Insert images via source URL} documentation.
+ *
+ * Adds the `'insertImage'` dropdown to the {@link module:ui/componentfactory~ComponentFactory UI component factory}
+ * and also the `imageInsert` dropdown as an alias for backward compatibility.
+ */
+export default class ImageInsertUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageInsertUI";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageUtils];
+    /**
+     * The dropdown view responsible for displaying the image insert UI.
+     */
+    dropdownView?: DropdownView;
+    /**
+     * Observable property used to alter labels while some image is selected and when it is not.
+     *
+     * @observable
+     */
+    isImageSelected: boolean;
+    /**
+     * Registered integrations map.
+     */
+    private _integrations;
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Registers the insert image dropdown integration.
+     */
+    registerIntegration({ name, observable, buttonViewCreator, formViewCreator, requiresForm }: {
+        name: string;
+        observable: Observable & {
+            isEnabled: boolean;
+        };
+        buttonViewCreator: (isOnlyOne: boolean) => ButtonView;
+        formViewCreator: (isOnlyOne: boolean) => FocusableView;
+        requiresForm?: boolean;
+    }): void;
+    /**
+     * Creates the toolbar component.
+     */
+    private _createToolbarComponent;
+    /**
+     * Validates the integrations list.
+     */
+    private _prepareIntegrations;
+}

package/src/imageinsert/imageinsertui.js

@@ -1,141 +1,174 @@
-/**
- * @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 image/imageinsert/imageinsertui
- */
-import { Plugin, icons } from 'ckeditor5/src/core';
-import { SplitButtonView, createDropdown } from 'ckeditor5/src/ui';
-import ImageInsertPanelView from './ui/imageinsertpanelview';
-import { prepareIntegrations } from './utils';
-/**
- * The image insert dropdown plugin.
- *
- * For a detailed overview, check the {@glink features/images/image-upload/image-upload Image upload feature}
- * and {@glink features/images/images-inserting Insert images via source URL} documentation.
- *
- * Adds the `'insertImage'` dropdown to the {@link module:ui/componentfactory~ComponentFactory UI component factory}
- * and also the `imageInsert` dropdown as an alias for backward compatibility.
- */
-export default class ImageInsertUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'ImageInsertUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const componentCreator = (locale) => {
-            return this._createDropdownView(locale);
-        };
-        // Register `insertImage` dropdown and add `imageInsert` dropdown as an alias for backward compatibility.
-        editor.ui.componentFactory.add('insertImage', componentCreator);
-        editor.ui.componentFactory.add('imageInsert', componentCreator);
-    }
-    /**
-     * Creates the dropdown view.
-     *
-     * @param locale The localization services instance.
-     */
-    _createDropdownView(locale) {
-        const editor = this.editor;
-        const t = locale.t;
-        const uploadImageCommand = editor.commands.get('uploadImage');
-        const insertImageCommand = editor.commands.get('insertImage');
-        this.dropdownView = createDropdown(locale, uploadImageCommand ? SplitButtonView : undefined);
-        const buttonView = this.dropdownView.buttonView;
-        const panelView = this.dropdownView.panelView;
-        buttonView.set({
-            label: t('Insert image'),
-            icon: icons.image,
-            tooltip: true
-        });
-        panelView.extendTemplate({
-            attributes: {
-                class: 'ck-image-insert__panel'
-            }
-        });
-        if (uploadImageCommand) {
-            const splitButtonView = this.dropdownView.buttonView;
-            // We are injecting custom button replacement to readonly field.
-            splitButtonView.actionView = editor.ui.componentFactory.create('uploadImage');
-            // After we replaced action button with `uploadImage` component,
-            // we have lost a proper styling and some minor visual quirks have appeared.
-            // Brining back original split button classes helps fix the button styling
-            // See https://github.com/ckeditor/ckeditor5/issues/7986.
-            splitButtonView.actionView.extendTemplate({
-                attributes: {
-                    class: 'ck ck-button ck-splitbutton__action'
-                }
-            });
-        }
-        return this._setUpDropdown(uploadImageCommand || insertImageCommand);
-    }
-    /**
-     * Sets up the dropdown view.
-     *
-     * @param command An uploadImage or insertImage command.
-     */
-    _setUpDropdown(command) {
-        const editor = this.editor;
-        const t = editor.t;
-        const dropdownView = this.dropdownView;
-        const panelView = dropdownView.panelView;
-        const imageUtils = this.editor.plugins.get('ImageUtils');
-        const replaceImageSourceCommand = editor.commands.get('replaceImageSource');
-        let imageInsertView;
-        dropdownView.bind('isEnabled').to(command);
-        dropdownView.once('change:isOpen', () => {
-            imageInsertView = new ImageInsertPanelView(editor.locale, prepareIntegrations(editor));
-            imageInsertView.delegate('submit', 'cancel').to(dropdownView);
-            panelView.children.add(imageInsertView);
-        });
-        dropdownView.on('change:isOpen', () => {
-            const selectedElement = editor.model.document.selection.getSelectedElement();
-            const insertButtonView = imageInsertView.insertButtonView;
-            const insertImageViaUrlForm = imageInsertView.getIntegration('insertImageViaUrl');
-            if (dropdownView.isOpen) {
-                if (imageUtils.isImage(selectedElement)) {
-                    imageInsertView.imageURLInputValue = replaceImageSourceCommand.value;
-                    insertButtonView.label = t('Update');
-                    insertImageViaUrlForm.label = t('Update image URL');
-                }
-                else {
-                    imageInsertView.imageURLInputValue = '';
-                    insertButtonView.label = t('Insert');
-                    insertImageViaUrlForm.label = t('Insert image via URL');
-                }
-            }
-            // Note: Use the low priority to make sure the following listener starts working after the
-            // default action of the drop-down is executed (i.e. the panel showed up). Otherwise, the
-            // invisible form/input cannot be focused/selected.
-        }, { priority: 'low' });
-        this.delegate('cancel').to(dropdownView);
-        dropdownView.on('submit', () => {
-            closePanel();
-            onSubmit();
-        });
-        dropdownView.on('cancel', () => {
-            closePanel();
-        });
-        function onSubmit() {
-            const selectedElement = editor.model.document.selection.getSelectedElement();
-            if (imageUtils.isImage(selectedElement)) {
-                editor.execute('replaceImageSource', { source: imageInsertView.imageURLInputValue });
-            }
-            else {
-                editor.execute('insertImage', { source: imageInsertView.imageURLInputValue });
-            }
-        }
-        function closePanel() {
-            editor.editing.view.focus();
-            dropdownView.isOpen = false;
-        }
-        return dropdownView;
-    }
-}
+/**
+ * @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 image/imageinsert/imageinsertui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { logWarning } from 'ckeditor5/src/utils';
+import { createDropdown, SplitButtonView } from 'ckeditor5/src/ui';
+import ImageInsertFormView from './ui/imageinsertformview';
+import ImageUtils from '../imageutils';
+/**
+ * The image insert dropdown plugin.
+ *
+ * For a detailed overview, check the {@glink features/images/image-upload/image-upload Image upload feature}
+ * and {@glink features/images/images-inserting Insert images via source URL} documentation.
+ *
+ * Adds the `'insertImage'` dropdown to the {@link module:ui/componentfactory~ComponentFactory UI component factory}
+ * and also the `imageInsert` dropdown as an alias for backward compatibility.
+ */
+export default class ImageInsertUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ImageInsertUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ImageUtils];
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        /**
+         * Registered integrations map.
+         */
+        this._integrations = new Map();
+        editor.config.define('image.insert.integrations', [
+            'upload',
+            'assetManager',
+            'url'
+        ]);
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const selection = editor.model.document.selection;
+        const imageUtils = editor.plugins.get('ImageUtils');
+        this.set('isImageSelected', false);
+        this.listenTo(editor.model.document, 'change', () => {
+            this.isImageSelected = imageUtils.isImage(selection.getSelectedElement());
+        });
+        const componentCreator = (locale) => this._createToolbarComponent(locale);
+        // Register `insertImage` dropdown and add `imageInsert` dropdown as an alias for backward compatibility.
+        editor.ui.componentFactory.add('insertImage', componentCreator);
+        editor.ui.componentFactory.add('imageInsert', componentCreator);
+    }
+    /**
+     * Registers the insert image dropdown integration.
+     */
+    registerIntegration({ name, observable, buttonViewCreator, formViewCreator, requiresForm }) {
+        if (this._integrations.has(name)) {
+            /**
+             * There are two insert-image integrations registered with the same name.
+             *
+             * Make sure that you do not load multiple asset manager plugins.
+             *
+             * @error image-insert-integration-exists
+             */
+            logWarning('image-insert-integration-exists', { name });
+        }
+        this._integrations.set(name, {
+            observable,
+            buttonViewCreator,
+            formViewCreator,
+            requiresForm: !!requiresForm
+        });
+    }
+    /**
+     * Creates the toolbar component.
+     */
+    _createToolbarComponent(locale) {
+        const editor = this.editor;
+        const t = locale.t;
+        const integrations = this._prepareIntegrations();
+        if (!integrations.length) {
+            return null;
+        }
+        let dropdownButton;
+        const firstIntegration = integrations[0];
+        if (integrations.length == 1) {
+            // Do not use dropdown for a single integration button (integration that does not require form view).
+            if (!firstIntegration.requiresForm) {
+                return firstIntegration.buttonViewCreator(true);
+            }
+            dropdownButton = firstIntegration.buttonViewCreator(true);
+        }
+        else {
+            const actionButton = firstIntegration.buttonViewCreator(false);
+            dropdownButton = new SplitButtonView(locale, actionButton);
+            dropdownButton.tooltip = true;
+            dropdownButton.bind('label').to(this, 'isImageSelected', isImageSelected => isImageSelected ?
+                t('Replace image') :
+                t('Insert image'));
+        }
+        const dropdownView = this.dropdownView = createDropdown(locale, dropdownButton);
+        const observables = integrations.map(({ observable }) => observable);
+        dropdownView.bind('isEnabled').toMany(observables, 'isEnabled', (...isEnabled) => (isEnabled.some(isEnabled => isEnabled)));
+        dropdownView.once('change:isOpen', () => {
+            const integrationViews = integrations.map(({ formViewCreator }) => formViewCreator(integrations.length == 1));
+            const imageInsertFormView = new ImageInsertFormView(editor.locale, integrationViews);
+            dropdownView.panelView.children.add(imageInsertFormView);
+        });
+        return dropdownView;
+    }
+    /**
+     * Validates the integrations list.
+     */
+    _prepareIntegrations() {
+        const editor = this.editor;
+        const items = editor.config.get('image.insert.integrations');
+        const result = [];
+        if (!items.length) {
+            /**
+             * The insert image feature requires a list of integrations to be provided in the editor configuration.
+             *
+             * The default list of integrations is `upload`, `assetManager`, `url`. Those integrations are included
+             * in the insert image dropdown if the given feature plugin is loaded. You should omit the `integrations`
+             * configuration key to use the default set or provide a selected list of integrations that should be used.
+             *
+             * @error image-insert-integrations-not-specified
+             */
+            logWarning('image-insert-integrations-not-specified');
+            return result;
+        }
+        for (const item of items) {
+            if (!this._integrations.has(item)) {
+                if (!['upload', 'assetManager', 'url'].includes(item)) {
+                    /**
+                     * The specified insert image integration name is unknown or the providing plugin is not loaded in the editor.
+                     *
+                     * @error image-insert-unknown-integration
+                     */
+                    logWarning('image-insert-unknown-integration', { item });
+                }
+                continue;
+            }
+            result.push(this._integrations.get(item));
+        }
+        if (!result.length) {
+            /**
+             * The image insert feature requires integrations to be registered by separate features.
+             *
+             * The `insertImage` toolbar button requires integrations to be registered by other features.
+             * For example {@link module:image/imageupload~ImageUpload ImageUpload},
+             * {@link module:image/imageinsert~ImageInsert ImageInsert},
+             * {@link module:image/imageinsertviaurl~ImageInsertViaUrl ImageInsertViaUrl},
+             * {@link module:ckbox/ckbox~CKBox CKBox}
+             *
+             * @error image-insert-integrations-not-registered
+             */
+            logWarning('image-insert-integrations-not-registered');
+        }
+        return result;
+    }
+}

package/src/imageinsert/imageinsertviaurlui.d.ts

@@ -0,0 +1,44 @@
+/**
+ * @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 image/imageinsert/imageinsertviaurlui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import ImageInsertUI from './imageinsertui';
+/**
+ * The image insert via URL plugin (UI part).
+ *
+ * For a detailed overview, check the {@glink features/images/images-inserting
+ * Insert images via source URL} documentation.
+ *
+ * This plugin registers the {@link module:image/imageinsert/imageinsertui~ImageInsertUI} integration for `url`.
+ */
+export default class ImageInsertViaUrlUI extends Plugin {
+    private _imageInsertUI;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageInsertViaUrlUI";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageInsertUI];
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Creates the view displayed in the dropdown.
+     */
+    private _createInsertUrlView;
+    /**
+     * Creates the toolbar button.
+     */
+    private _createInsertUrlButton;
+    /**
+     * Closes the dropdown.
+     */
+    private _closePanel;
+}