@ckeditor/ckeditor5-image 40.0.0 → 40.2.0

package/src/imageinsert/imageinsertviaurlui.js

@@ -0,0 +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 image/imageinsert/imageinsertviaurlui
+ */
+import { icons, Plugin } from 'ckeditor5/src/core';
+import { ButtonView, CollapsibleView, DropdownButtonView } from 'ckeditor5/src/ui';
+import ImageInsertUI from './imageinsertui';
+import ImageInsertUrlView from './ui/imageinserturlview';
+/**
+ * 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 {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ImageInsertViaUrlUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ImageInsertUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        this._imageInsertUI = this.editor.plugins.get('ImageInsertUI');
+        const insertImageCommand = this.editor.commands.get('insertImage');
+        this._imageInsertUI.registerIntegration({
+            name: 'url',
+            observable: insertImageCommand,
+            requiresForm: true,
+            buttonViewCreator: isOnlyOne => this._createInsertUrlButton(isOnlyOne),
+            formViewCreator: isOnlyOne => this._createInsertUrlView(isOnlyOne)
+        });
+    }
+    /**
+     * Creates the view displayed in the dropdown.
+     */
+    _createInsertUrlView(isOnlyOne) {
+        const editor = this.editor;
+        const locale = editor.locale;
+        const t = locale.t;
+        const replaceImageSourceCommand = editor.commands.get('replaceImageSource');
+        const insertImageCommand = editor.commands.get('insertImage');
+        const imageInsertUrlView = new ImageInsertUrlView(locale);
+        const collapsibleView = isOnlyOne ? null : new CollapsibleView(locale, [imageInsertUrlView]);
+        imageInsertUrlView.bind('isImageSelected').to(this._imageInsertUI);
+        imageInsertUrlView.bind('isEnabled').toMany([insertImageCommand, replaceImageSourceCommand], 'isEnabled', (...isEnabled) => (isEnabled.some(isCommandEnabled => isCommandEnabled)));
+        // Set initial value because integrations are created on first dropdown open.
+        imageInsertUrlView.imageURLInputValue = replaceImageSourceCommand.value || '';
+        this._imageInsertUI.dropdownView.on('change:isOpen', () => {
+            if (this._imageInsertUI.dropdownView.isOpen) {
+                // Make sure that each time the panel shows up, the URL field remains in sync with the value of
+                // the command. If the user typed in the input, then canceled and re-opened it without changing
+                // the value of the media command (e.g. because they didn't change the selection), they would see
+                // the old value instead of the actual value of the command.
+                imageInsertUrlView.imageURLInputValue = replaceImageSourceCommand.value || '';
+                if (collapsibleView) {
+                    collapsibleView.isCollapsed = true;
+                }
+            }
+            // 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' });
+        imageInsertUrlView.on('submit', () => {
+            if (replaceImageSourceCommand.isEnabled) {
+                editor.execute('replaceImageSource', { source: imageInsertUrlView.imageURLInputValue });
+            }
+            else {
+                editor.execute('insertImage', { source: imageInsertUrlView.imageURLInputValue });
+            }
+            this._closePanel();
+        });
+        imageInsertUrlView.on('cancel', () => this._closePanel());
+        if (collapsibleView) {
+            collapsibleView.set({
+                isCollapsed: true
+            });
+            collapsibleView.bind('label').to(this._imageInsertUI, 'isImageSelected', isImageSelected => isImageSelected ?
+                t('Update image URL') :
+                t('Insert image via URL'));
+            return collapsibleView;
+        }
+        return imageInsertUrlView;
+    }
+    /**
+     * Creates the toolbar button.
+     */
+    _createInsertUrlButton(isOnlyOne) {
+        const ButtonClass = isOnlyOne ? DropdownButtonView : ButtonView;
+        const editor = this.editor;
+        const button = new ButtonClass(editor.locale);
+        const t = editor.locale.t;
+        button.set({
+            icon: icons.imageUrl,
+            tooltip: true
+        });
+        button.bind('label').to(this._imageInsertUI, 'isImageSelected', isImageSelected => isImageSelected ?
+            t('Update image URL') :
+            t('Insert image via URL'));
+        return button;
+    }
+    /**
+     * Closes the dropdown.
+     */
+    _closePanel() {
+        this.editor.editing.view.focus();
+        this._imageInsertUI.dropdownView.isOpen = false;
+    }
+}

package/src/imageinsert/ui/imageinsertformview.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @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/ui/imageinsertformview
+ */
+import { View, ViewCollection, FocusCycler } from 'ckeditor5/src/ui';
+import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils';
+import '../../../theme/imageinsert.css';
+/**
+ * The view displayed in the insert image dropdown.
+ *
+ * See {@link module:image/imageinsert/imageinsertui~ImageInsertUI}.
+ */
+export default class ImageInsertFormView extends View {
+    /**
+     * Tracks information about DOM focus in the form.
+     */
+    readonly focusTracker: FocusTracker;
+    /**
+     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+     */
+    readonly keystrokes: KeystrokeHandler;
+    /**
+     * A collection of views that can be focused in the form.
+     */
+    protected readonly _focusables: ViewCollection;
+    /**
+     * Helps cycling over {@link #_focusables} in the form.
+     */
+    protected readonly _focusCycler: FocusCycler;
+    /**
+     * A collection of the defined integrations for inserting the images.
+     */
+    private readonly children;
+    /**
+     * Creates a view for the dropdown panel of {@link module:image/imageinsert/imageinsertui~ImageInsertUI}.
+     *
+     * @param locale The localization services instance.
+     * @param integrations An integrations object that contains components (or tokens for components) to be shown in the panel view.
+     */
+    constructor(locale: Locale, integrations?: Array<View>);
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Focuses the first {@link #_focusables focusable} in the form.
+     */
+    focus(): void;
+}

package/src/imageinsert/ui/imageinsertformview.js

@@ -0,0 +1,112 @@
+/**
+ * @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/ui/imageinsertformview
+ */
+import { View, ViewCollection, submitHandler, FocusCycler, CollapsibleView } from 'ckeditor5/src/ui';
+import { FocusTracker, KeystrokeHandler } from 'ckeditor5/src/utils';
+import '../../../theme/imageinsert.css';
+/**
+ * The view displayed in the insert image dropdown.
+ *
+ * See {@link module:image/imageinsert/imageinsertui~ImageInsertUI}.
+ */
+export default class ImageInsertFormView extends View {
+    /**
+     * Creates a view for the dropdown panel of {@link module:image/imageinsert/imageinsertui~ImageInsertUI}.
+     *
+     * @param locale The localization services instance.
+     * @param integrations An integrations object that contains components (or tokens for components) to be shown in the panel view.
+     */
+    constructor(locale, integrations = []) {
+        super(locale);
+        this.focusTracker = new FocusTracker();
+        this.keystrokes = new KeystrokeHandler();
+        this._focusables = new ViewCollection();
+        this.children = this.createCollection();
+        this._focusCycler = new FocusCycler({
+            focusables: this._focusables,
+            focusTracker: this.focusTracker,
+            keystrokeHandler: this.keystrokes,
+            actions: {
+                // Navigate form fields backwards using the Shift + Tab keystroke.
+                focusPrevious: 'shift + tab',
+                // Navigate form fields forwards using the Tab key.
+                focusNext: 'tab'
+            }
+        });
+        for (const view of integrations) {
+            this.children.add(view);
+            this._focusables.add(view);
+            if (view instanceof CollapsibleView) {
+                this._focusables.addMany(view.children);
+            }
+        }
+        if (this._focusables.length > 1) {
+            for (const view of this._focusables) {
+                if (isViewWithFocusCycler(view)) {
+                    view.focusCycler.on('forwardCycle', evt => {
+                        this._focusCycler.focusNext();
+                        evt.stop();
+                    });
+                    view.focusCycler.on('backwardCycle', evt => {
+                        this._focusCycler.focusPrevious();
+                        evt.stop();
+                    });
+                }
+            }
+        }
+        this.setTemplate({
+            tag: 'form',
+            attributes: {
+                class: [
+                    'ck',
+                    'ck-image-insert-form'
+                ],
+                tabindex: -1
+            },
+            children: this.children
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    render() {
+        super.render();
+        submitHandler({
+            view: this
+        });
+        for (const view of this._focusables) {
+            this.focusTracker.add(view.element);
+        }
+        // Start listening for the keystrokes coming from #element.
+        this.keystrokes.listenTo(this.element);
+        const stopPropagation = (data) => data.stopPropagation();
+        // Since the form is in the dropdown panel which is a child of the toolbar, the toolbar's
+        // keystroke handler would take over the key management in the URL input. We need to prevent
+        // this ASAP. Otherwise, the basic caret movement using the arrow keys will be impossible.
+        this.keystrokes.set('arrowright', stopPropagation);
+        this.keystrokes.set('arrowleft', stopPropagation);
+        this.keystrokes.set('arrowup', stopPropagation);
+        this.keystrokes.set('arrowdown', stopPropagation);
+    }
+    /**
+     * @inheritDoc
+     */
+    destroy() {
+        super.destroy();
+        this.focusTracker.destroy();
+        this.keystrokes.destroy();
+    }
+    /**
+     * Focuses the first {@link #_focusables focusable} in the form.
+     */
+    focus() {
+        this._focusCycler.focusFirst();
+    }
+}
+function isViewWithFocusCycler(view) {
+    return 'focusCycler' in view;
+}

package/src/imageinsert/ui/imageinserturlview.d.ts

@@ -0,0 +1,107 @@
+/**
+ * @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 { ButtonView, View, FocusCycler, LabeledFieldView, type InputTextView } from 'ckeditor5/src/ui';
+import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils';
+/**
+ * The insert an image via URL view.
+ *
+ * See {@link module:image/imageinsert/imageinsertviaurlui~ImageInsertViaUrlUI}.
+ */
+export default class ImageInsertUrlView extends View {
+    /**
+     * The URL input field view.
+     */
+    urlInputView: LabeledFieldView<InputTextView>;
+    /**
+     * The "insert/update" button view.
+     */
+    insertButtonView: ButtonView;
+    /**
+     * The "cancel" button view.
+     */
+    cancelButtonView: ButtonView;
+    /**
+     * The value of the URL input.
+     *
+     * @observable
+     */
+    imageURLInputValue: string;
+    /**
+     * Observable property used to alter labels while some image is selected and when it is not.
+     *
+     * @observable
+     */
+    isImageSelected: boolean;
+    /**
+     * Observable property indicating whether the form interactive elements should be enabled.
+     *
+     * @observable
+     */
+    isEnabled: boolean;
+    /**
+     * Tracks information about DOM focus in the form.
+     */
+    readonly focusTracker: FocusTracker;
+    /**
+     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+     */
+    readonly keystrokes: KeystrokeHandler;
+    /**
+     * Helps cycling over {@link #_focusables} in the form.
+     */
+    readonly focusCycler: FocusCycler;
+    /**
+     * A collection of views that can be focused in the form.
+     */
+    private readonly _focusables;
+    /**
+     * Creates a view for the dropdown panel of {@link module:image/imageinsert/imageinsertui~ImageInsertUI}.
+     *
+     * @param locale The localization services instance.
+     */
+    constructor(locale: Locale);
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Creates the {@link #urlInputView}.
+     */
+    private _createUrlInputView;
+    /**
+     * Creates the {@link #insertButtonView}.
+     */
+    private _createInsertButton;
+    /**
+     * Creates the {@link #cancelButtonView}.
+     */
+    private _createCancelButton;
+    /**
+     * Focuses the view.
+     */
+    focus(direction: 1 | -1): void;
+}
+/**
+ * Fired when the form view is submitted.
+ *
+ * @eventName ~ImageInsertUrlView#submit
+ */
+export type ImageInsertUrlViewSubmitEvent = {
+    name: 'submit';
+    args: [];
+};
+/**
+ * Fired when the form view is canceled.
+ *
+ * @eventName ~ImageInsertUrlView#cancel
+ */
+export type ImageInsertUrlViewCancelEvent = {
+    name: 'cancel';
+    args: [];
+};

package/src/imageinsert/ui/imageinserturlview.js

@@ -0,0 +1,156 @@
+/**
+ * @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/ui/imageinserturlview
+ */
+import { icons } from 'ckeditor5/src/core';
+import { ButtonView, View, ViewCollection, FocusCycler, LabeledFieldView, createLabeledInputText } from 'ckeditor5/src/ui';
+import { FocusTracker, KeystrokeHandler } from 'ckeditor5/src/utils';
+/**
+ * The insert an image via URL view.
+ *
+ * See {@link module:image/imageinsert/imageinsertviaurlui~ImageInsertViaUrlUI}.
+ */
+export default class ImageInsertUrlView extends View {
+    /**
+     * Creates a view for the dropdown panel of {@link module:image/imageinsert/imageinsertui~ImageInsertUI}.
+     *
+     * @param locale The localization services instance.
+     */
+    constructor(locale) {
+        super(locale);
+        this.set('imageURLInputValue', '');
+        this.set('isImageSelected', false);
+        this.set('isEnabled', true);
+        this.focusTracker = new FocusTracker();
+        this.keystrokes = new KeystrokeHandler();
+        this._focusables = new ViewCollection();
+        this.focusCycler = new FocusCycler({
+            focusables: this._focusables,
+            focusTracker: this.focusTracker,
+            keystrokeHandler: this.keystrokes,
+            actions: {
+                // Navigate form fields backwards using the Shift + Tab keystroke.
+                focusPrevious: 'shift + tab',
+                // Navigate form fields forwards using the Tab key.
+                focusNext: 'tab'
+            }
+        });
+        this.urlInputView = this._createUrlInputView();
+        this.insertButtonView = this._createInsertButton();
+        this.cancelButtonView = this._createCancelButton();
+        this._focusables.addMany([
+            this.urlInputView,
+            this.insertButtonView,
+            this.cancelButtonView
+        ]);
+        this.setTemplate({
+            tag: 'div',
+            attributes: {
+                class: [
+                    'ck',
+                    'ck-image-insert-url'
+                ]
+            },
+            children: [
+                this.urlInputView,
+                {
+                    tag: 'div',
+                    attributes: {
+                        class: [
+                            'ck',
+                            'ck-image-insert-url__action-row'
+                        ]
+                    },
+                    children: [
+                        this.insertButtonView,
+                        this.cancelButtonView
+                    ]
+                }
+            ]
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    render() {
+        super.render();
+        for (const view of this._focusables) {
+            this.focusTracker.add(view.element);
+        }
+        // Start listening for the keystrokes coming from #element.
+        this.keystrokes.listenTo(this.element);
+    }
+    /**
+     * @inheritDoc
+     */
+    destroy() {
+        super.destroy();
+        this.focusTracker.destroy();
+        this.keystrokes.destroy();
+    }
+    /**
+     * Creates the {@link #urlInputView}.
+     */
+    _createUrlInputView() {
+        const locale = this.locale;
+        const t = locale.t;
+        const urlInputView = new LabeledFieldView(locale, createLabeledInputText);
+        urlInputView.bind('label').to(this, 'isImageSelected', value => value ? t('Update image URL') : t('Insert image via URL'));
+        urlInputView.bind('isEnabled').to(this);
+        urlInputView.fieldView.placeholder = 'https://example.com/image.png';
+        urlInputView.fieldView.bind('value').to(this, 'imageURLInputValue', (value) => value || '');
+        urlInputView.fieldView.on('input', () => {
+            this.imageURLInputValue = urlInputView.fieldView.element.value.trim();
+        });
+        return urlInputView;
+    }
+    /**
+     * Creates the {@link #insertButtonView}.
+     */
+    _createInsertButton() {
+        const locale = this.locale;
+        const t = locale.t;
+        const insertButtonView = new ButtonView(locale);
+        insertButtonView.set({
+            icon: icons.check,
+            class: 'ck-button-save',
+            type: 'submit',
+            withText: true
+        });
+        insertButtonView.bind('label').to(this, 'isImageSelected', value => value ? t('Update') : t('Insert'));
+        insertButtonView.bind('isEnabled').to(this, 'imageURLInputValue', this, 'isEnabled', (...values) => values.every(value => value));
+        insertButtonView.delegate('execute').to(this, 'submit');
+        return insertButtonView;
+    }
+    /**
+     * Creates the {@link #cancelButtonView}.
+     */
+    _createCancelButton() {
+        const locale = this.locale;
+        const t = locale.t;
+        const cancelButtonView = new ButtonView(locale);
+        cancelButtonView.set({
+            label: t('Cancel'),
+            icon: icons.cancel,
+            class: 'ck-button-cancel',
+            withText: true
+        });
+        cancelButtonView.bind('isEnabled').to(this);
+        cancelButtonView.delegate('execute').to(this, 'cancel');
+        return cancelButtonView;
+    }
+    /**
+     * Focuses the view.
+     */
+    focus(direction) {
+        if (direction === -1) {
+            this.focusCycler.focusLast();
+        }
+        else {
+            this.focusCycler.focusFirst();
+        }
+    }
+}

package/src/imageinsert.d.ts

@@ -1,33 +1,33 @@
-/**
- * @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
- */
-import { Plugin } from 'ckeditor5/src/core';
-import ImageUpload from './imageupload';
-import ImageInsertViaUrl from './imageinsertviaurl';
-import ImageInsertUI from './imageinsert/imageinsertui';
-/**
- * The image insert 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.
- *
- * This plugin does not do anything directly, but it loads a set of specific plugins
- * to enable image uploading or inserting via implemented integrations:
- *
- * * {@link module:image/imageupload~ImageUpload}
- * * {@link module:image/imageinsert/imageinsertui~ImageInsertUI}
- */
-export default class ImageInsert extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageInsert";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageUpload, typeof ImageInsertViaUrl, typeof ImageInsertUI];
-}
+/**
+ * @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
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import ImageUpload from './imageupload';
+import ImageInsertViaUrl from './imageinsertviaurl';
+import ImageInsertUI from './imageinsert/imageinsertui';
+/**
+ * The image insert 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.
+ *
+ * This plugin does not do anything directly, but it loads a set of specific plugins
+ * to enable image uploading or inserting via implemented integrations:
+ *
+ * * {@link module:image/imageupload~ImageUpload}
+ * * {@link module:image/imageinsert/imageinsertui~ImageInsertUI}
+ */
+export default class ImageInsert extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageInsert";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageUpload, typeof ImageInsertViaUrl, typeof ImageInsertUI];
+}