@ckeditor/ckeditor5-image 39.0.1 → 40.0.0

package/src/imageinsert/utils.d.ts

@@ -1,25 +1,25 @@
-/**
- * @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/utils
- */
-import type { Locale } from 'ckeditor5/src/utils';
-import type { Editor } from 'ckeditor5/src/core';
-import { LabeledFieldView, type View } from 'ckeditor5/src/ui';
-/**
- * Creates integrations object that will be passed to the
- * {@link module:image/imageinsert/ui/imageinsertpanelview~ImageInsertPanelView}.
- *
- * @param editor Editor instance.
- *
- * @returns Integrations object.
- */
-export declare function prepareIntegrations(editor: Editor): Record<string, View>;
-/**
- * Creates labeled field view.
- *
- * @param locale The localization services instance.
- */
-export declare function createLabeledInputView(locale: Locale): LabeledFieldView;
+/**
+ * @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/utils
+ */
+import type { Locale } from 'ckeditor5/src/utils';
+import type { Editor } from 'ckeditor5/src/core';
+import { LabeledFieldView, type View } from 'ckeditor5/src/ui';
+/**
+ * Creates integrations object that will be passed to the
+ * {@link module:image/imageinsert/ui/imageinsertpanelview~ImageInsertPanelView}.
+ *
+ * @param editor Editor instance.
+ *
+ * @returns Integrations object.
+ */
+export declare function prepareIntegrations(editor: Editor): Record<string, View>;
+/**
+ * Creates labeled field view.
+ *
+ * @param locale The localization services instance.
+ */
+export declare function createLabeledInputView(locale: Locale): LabeledFieldView;

package/src/imageinsert/utils.js

@@ -1,58 +1,58 @@
-/**
- * @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 { LabeledFieldView, createLabeledInputText } from 'ckeditor5/src/ui';
-/**
- * Creates integrations object that will be passed to the
- * {@link module:image/imageinsert/ui/imageinsertpanelview~ImageInsertPanelView}.
- *
- * @param editor Editor instance.
- *
- * @returns Integrations object.
- */
-export function prepareIntegrations(editor) {
-    const panelItems = editor.config.get('image.insert.integrations');
-    const imageInsertUIPlugin = editor.plugins.get('ImageInsertUI');
-    const PREDEFINED_INTEGRATIONS = {
-        'insertImageViaUrl': createLabeledInputView(editor.locale)
-    };
-    if (!panelItems) {
-        return PREDEFINED_INTEGRATIONS;
-    }
-    // Prepares ckfinder component for the `openCKFinder` integration token.
-    if (panelItems.find(item => item === 'openCKFinder') && editor.ui.componentFactory.has('ckfinder')) {
-        const ckFinderButton = editor.ui.componentFactory.create('ckfinder');
-        ckFinderButton.set({
-            withText: true,
-            class: 'ck-image-insert__ck-finder-button'
-        });
-        // We want to close the dropdown panel view when user clicks the ckFinderButton.
-        ckFinderButton.delegate('execute').to(imageInsertUIPlugin, 'cancel');
-        PREDEFINED_INTEGRATIONS.openCKFinder = ckFinderButton;
-    }
-    // Creates integrations object of valid views to pass it to the ImageInsertPanelView.
-    return panelItems.reduce((object, key) => {
-        if (PREDEFINED_INTEGRATIONS[key]) {
-            object[key] = PREDEFINED_INTEGRATIONS[key];
-        }
-        else if (editor.ui.componentFactory.has(key)) {
-            object[key] = editor.ui.componentFactory.create(key);
-        }
-        return object;
-    }, {});
-}
-/**
- * Creates labeled field view.
- *
- * @param locale The localization services instance.
- */
-export function createLabeledInputView(locale) {
-    const t = locale.t;
-    const labeledInputView = new LabeledFieldView(locale, createLabeledInputText);
-    labeledInputView.set({
-        label: t('Insert image via URL')
-    });
-    labeledInputView.fieldView.placeholder = 'https://example.com/image.png';
-    return labeledInputView;
-}
+/**
+ * @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 { LabeledFieldView, createLabeledInputText } from 'ckeditor5/src/ui';
+/**
+ * Creates integrations object that will be passed to the
+ * {@link module:image/imageinsert/ui/imageinsertpanelview~ImageInsertPanelView}.
+ *
+ * @param editor Editor instance.
+ *
+ * @returns Integrations object.
+ */
+export function prepareIntegrations(editor) {
+    const panelItems = editor.config.get('image.insert.integrations');
+    const imageInsertUIPlugin = editor.plugins.get('ImageInsertUI');
+    const PREDEFINED_INTEGRATIONS = {
+        'insertImageViaUrl': createLabeledInputView(editor.locale)
+    };
+    if (!panelItems) {
+        return PREDEFINED_INTEGRATIONS;
+    }
+    // Prepares ckfinder component for the `openCKFinder` integration token.
+    if (panelItems.find(item => item === 'openCKFinder') && editor.ui.componentFactory.has('ckfinder')) {
+        const ckFinderButton = editor.ui.componentFactory.create('ckfinder');
+        ckFinderButton.set({
+            withText: true,
+            class: 'ck-image-insert__ck-finder-button'
+        });
+        // We want to close the dropdown panel view when user clicks the ckFinderButton.
+        ckFinderButton.delegate('execute').to(imageInsertUIPlugin, 'cancel');
+        PREDEFINED_INTEGRATIONS.openCKFinder = ckFinderButton;
+    }
+    // Creates integrations object of valid views to pass it to the ImageInsertPanelView.
+    return panelItems.reduce((object, key) => {
+        if (PREDEFINED_INTEGRATIONS[key]) {
+            object[key] = PREDEFINED_INTEGRATIONS[key];
+        }
+        else if (editor.ui.componentFactory.has(key)) {
+            object[key] = editor.ui.componentFactory.create(key);
+        }
+        return object;
+    }, {});
+}
+/**
+ * Creates labeled field view.
+ *
+ * @param locale The localization services instance.
+ */
+export function createLabeledInputView(locale) {
+    const t = locale.t;
+    const labeledInputView = new LabeledFieldView(locale, createLabeledInputText);
+    labeledInputView.set({
+        label: t('Insert image via URL')
+    });
+    labeledInputView.fieldView.placeholder = 'https://example.com/image.png';
+    return labeledInputView;
+}

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];
+}

package/src/imageinsert.js

@@ -1,37 +1,37 @@
-/**
- * @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() {
-        return 'ImageInsert';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [ImageUpload, ImageInsertViaUrl, 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() {
+        return 'ImageInsert';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ImageUpload, ImageInsertViaUrl, ImageInsertUI];
+    }
+}

package/src/imageinsertviaurl.d.ts

@@ -1,30 +1,30 @@
-/**
- * @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/imageinsertviaurl
- */
-import { Plugin } from 'ckeditor5/src/core';
-import ImageInsertUI from './imageinsert/imageinsertui';
-/**
- * The image insert via URL plugin.
- *
- * For a detailed overview, check the {@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 inserting via implemented integrations:
- *
- * * {@link module:image/imageinsert/imageinsertui~ImageInsertUI},
- */
-export default class ImageInsertViaUrl extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageInsertViaUrl";
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [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/imageinsertviaurl
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import ImageInsertUI from './imageinsert/imageinsertui';
+/**
+ * The image insert via URL plugin.
+ *
+ * For a detailed overview, check the {@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 inserting via implemented integrations:
+ *
+ * * {@link module:image/imageinsert/imageinsertui~ImageInsertUI},
+ */
+export default class ImageInsertViaUrl extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageInsertViaUrl";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageInsertUI];
+}

package/src/imageinsertviaurl.js

@@ -1,34 +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/imageinsertviaurl
- */
-import { Plugin } from 'ckeditor5/src/core';
-import ImageInsertUI from './imageinsert/imageinsertui';
-/**
- * The image insert via URL plugin.
- *
- * For a detailed overview, check the {@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 inserting via implemented integrations:
- *
- * * {@link module:image/imageinsert/imageinsertui~ImageInsertUI},
- */
-export default class ImageInsertViaUrl extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'ImageInsertViaUrl';
-    }
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [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/imageinsertviaurl
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import ImageInsertUI from './imageinsert/imageinsertui';
+/**
+ * The image insert via URL plugin.
+ *
+ * For a detailed overview, check the {@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 inserting via implemented integrations:
+ *
+ * * {@link module:image/imageinsert/imageinsertui~ImageInsertUI},
+ */
+export default class ImageInsertViaUrl extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'ImageInsertViaUrl';
+    }
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [ImageInsertUI];
+    }
+}

package/src/imageresize/imageresizebuttons.d.ts

@@ -1,67 +1,67 @@
-/**
- * @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/imageresize/imageresizebuttons
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-import ImageResizeEditing from './imageresizeediting';
-/**
- * The image resize buttons plugin.
- *
- * It adds a possibility to resize images using the toolbar dropdown or individual buttons, depending on the plugin configuration.
- */
-export default class ImageResizeButtons extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageResizeEditing];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageResizeButtons";
-    /**
-     * The resize unit.
-     * @default '%'
-     */
-    private readonly _resizeUnit;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * A helper function that creates a standalone button component for the plugin.
-     *
-     * @param resizeOption A model of the resize option.
-     */
-    private _registerImageResizeButton;
-    /**
-     * A helper function that creates a dropdown component for the plugin containing all the resize options defined in
-     * the editor configuration.
-     *
-     * @param options An array of configured options.
-     */
-    private _registerImageResizeDropdown;
-    /**
-     * A helper function for creating an option label value string.
-     *
-     * @param option A resize option object.
-     * @param forTooltip An optional flag for creating a tooltip label.
-     * @returns A user-defined label combined from the numeric value and the resize unit or the default label
-     * for reset options (`Original`).
-     */
-    private _getOptionLabelValue;
-    /**
-     * A helper function that parses the resize options and returns list item definitions ready for use in the dropdown.
-     *
-     * @param options The resize options.
-     * @param command The resize image command.
-     * @returns Dropdown item definitions.
-     */
-    private _getResizeDropdownListItemDefinitions;
-}
+/**
+ * @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/imageresize/imageresizebuttons
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+import ImageResizeEditing from './imageresizeediting';
+/**
+ * The image resize buttons plugin.
+ *
+ * It adds a possibility to resize images using the toolbar dropdown or individual buttons, depending on the plugin configuration.
+ */
+export default class ImageResizeButtons extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageResizeEditing];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageResizeButtons";
+    /**
+     * The resize unit.
+     * @default '%'
+     */
+    private readonly _resizeUnit;
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * A helper function that creates a standalone button component for the plugin.
+     *
+     * @param resizeOption A model of the resize option.
+     */
+    private _registerImageResizeButton;
+    /**
+     * A helper function that creates a dropdown component for the plugin containing all the resize options defined in
+     * the editor configuration.
+     *
+     * @param options An array of configured options.
+     */
+    private _registerImageResizeDropdown;
+    /**
+     * A helper function for creating an option label value string.
+     *
+     * @param option A resize option object.
+     * @param forTooltip An optional flag for creating a tooltip label.
+     * @returns A user-defined label combined from the numeric value and the resize unit or the default label
+     * for reset options (`Original`).
+     */
+    private _getOptionLabelValue;
+    /**
+     * A helper function that parses the resize options and returns list item definitions ready for use in the dropdown.
+     *
+     * @param options The resize options.
+     * @param command The resize image command.
+     * @returns Dropdown item definitions.
+     */
+    private _getResizeDropdownListItemDefinitions;
+}