@ckeditor/ckeditor5-media-embed 38.1.1 → 38.2.0-alpha.1

package/src/mediaembedui.d.ts

@@ -1,27 +1,27 @@
-/**
- * @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 media-embed/mediaembedui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import MediaEmbedEditing from './mediaembedediting';
-/**
- * The media embed UI plugin.
- */
-export default class MediaEmbedUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof MediaEmbedEditing];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "MediaEmbedUI";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    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 media-embed/mediaembedui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import MediaEmbedEditing from './mediaembedediting.js';
+/**
+ * The media embed UI plugin.
+ */
+export default class MediaEmbedUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof MediaEmbedEditing];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "MediaEmbedUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    private _setUpDropdown;
+}

package/src/mediaembedui.js

@@ -1,99 +1,99 @@
-/**
- * @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 media-embed/mediaembedui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { createDropdown, CssTransitionDisablerMixin } from 'ckeditor5/src/ui';
-import MediaFormView from './ui/mediaformview';
-import MediaEmbedEditing from './mediaembedediting';
-import mediaIcon from '../theme/icons/media.svg';
-/**
- * The media embed UI plugin.
- */
-export default class MediaEmbedUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [MediaEmbedEditing];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'MediaEmbedUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const command = editor.commands.get('mediaEmbed');
-        editor.ui.componentFactory.add('mediaEmbed', locale => {
-            const dropdown = createDropdown(locale);
-            this._setUpDropdown(dropdown, command);
-            return dropdown;
-        });
-    }
-    _setUpDropdown(dropdown, command) {
-        const editor = this.editor;
-        const t = editor.t;
-        const button = dropdown.buttonView;
-        const registry = editor.plugins.get(MediaEmbedEditing).registry;
-        dropdown.once('change:isOpen', () => {
-            const form = new (CssTransitionDisablerMixin(MediaFormView))(getFormValidators(editor.t, registry), editor.locale);
-            dropdown.panelView.children.add(form);
-            // 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.
-            button.on('open', () => {
-                form.disableCssTransitions();
-                // 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 (`urlInputView#fieldView#value` stays
-                // unaltered) 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.
-                form.url = command.value || '';
-                form.urlInputView.fieldView.select();
-                form.enableCssTransitions();
-            }, { priority: 'low' });
-            dropdown.on('submit', () => {
-                if (form.isValid()) {
-                    editor.execute('mediaEmbed', form.url);
-                    editor.editing.view.focus();
-                }
-            });
-            dropdown.on('change:isOpen', () => form.resetFormStatus());
-            dropdown.on('cancel', () => {
-                editor.editing.view.focus();
-            });
-            form.delegate('submit', 'cancel').to(dropdown);
-            form.urlInputView.fieldView.bind('value').to(command, 'value');
-            // Form elements should be read-only when corresponding commands are disabled.
-            form.urlInputView.bind('isEnabled').to(command, 'isEnabled');
-        });
-        dropdown.bind('isEnabled').to(command);
-        button.set({
-            label: t('Insert media'),
-            icon: mediaIcon,
-            tooltip: true
-        });
-    }
-}
-function getFormValidators(t, registry) {
-    return [
-        form => {
-            if (!form.url.length) {
-                return t('The URL must not be empty.');
-            }
-        },
-        form => {
-            if (!registry.hasMedia(form.url)) {
-                return t('This media URL is not supported.');
-            }
-        }
-    ];
-}
+/**
+ * @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 media-embed/mediaembedui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { createDropdown, CssTransitionDisablerMixin } from 'ckeditor5/src/ui.js';
+import MediaFormView from './ui/mediaformview.js';
+import MediaEmbedEditing from './mediaembedediting.js';
+import mediaIcon from '../theme/icons/media.svg';
+/**
+ * The media embed UI plugin.
+ */
+export default class MediaEmbedUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [MediaEmbedEditing];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'MediaEmbedUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const command = editor.commands.get('mediaEmbed');
+        editor.ui.componentFactory.add('mediaEmbed', locale => {
+            const dropdown = createDropdown(locale);
+            this._setUpDropdown(dropdown, command);
+            return dropdown;
+        });
+    }
+    _setUpDropdown(dropdown, command) {
+        const editor = this.editor;
+        const t = editor.t;
+        const button = dropdown.buttonView;
+        const registry = editor.plugins.get(MediaEmbedEditing).registry;
+        dropdown.once('change:isOpen', () => {
+            const form = new (CssTransitionDisablerMixin(MediaFormView))(getFormValidators(editor.t, registry), editor.locale);
+            dropdown.panelView.children.add(form);
+            // 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.
+            button.on('open', () => {
+                form.disableCssTransitions();
+                // 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 (`urlInputView#fieldView#value` stays
+                // unaltered) 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.
+                form.url = command.value || '';
+                form.urlInputView.fieldView.select();
+                form.enableCssTransitions();
+            }, { priority: 'low' });
+            dropdown.on('submit', () => {
+                if (form.isValid()) {
+                    editor.execute('mediaEmbed', form.url);
+                    editor.editing.view.focus();
+                }
+            });
+            dropdown.on('change:isOpen', () => form.resetFormStatus());
+            dropdown.on('cancel', () => {
+                editor.editing.view.focus();
+            });
+            form.delegate('submit', 'cancel').to(dropdown);
+            form.urlInputView.fieldView.bind('value').to(command, 'value');
+            // Form elements should be read-only when corresponding commands are disabled.
+            form.urlInputView.bind('isEnabled').to(command, 'isEnabled');
+        });
+        dropdown.bind('isEnabled').to(command);
+        button.set({
+            label: t('Insert media'),
+            icon: mediaIcon,
+            tooltip: true
+        });
+    }
+}
+function getFormValidators(t, registry) {
+    return [
+        form => {
+            if (!form.url.length) {
+                return t('The URL must not be empty.');
+            }
+        },
+        form => {
+            if (!registry.hasMedia(form.url)) {
+                return t('This media URL is not supported.');
+            }
+        }
+    ];
+}

package/src/mediaregistry.d.ts

@@ -1,66 +1,66 @@
-/**
- * @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 media-embed/mediaregistry
- */
-import type { DowncastWriter, ViewElement } from 'ckeditor5/src/engine';
-import { type Locale } from 'ckeditor5/src/utils';
-import type { MediaEmbedConfig, MediaEmbedProvider } from './mediaembedconfig';
-import type { MediaOptions } from './utils';
-/**
- * A bridge between the raw media content provider definitions and the editor view content.
- *
- * It helps translating media URLs to corresponding {@link module:engine/view/element~Element view elements}.
- *
- * Mostly used by the {@link module:media-embed/mediaembedediting~MediaEmbedEditing} plugin.
- */
-export default class MediaRegistry {
-    /**
-     * The {@link module:utils/locale~Locale} instance.
-     */
-    locale: Locale;
-    /**
-     * The media provider definitions available for the registry. Usually corresponding with the
-     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig media configuration}.
-     */
-    providerDefinitions: Array<MediaEmbedProvider>;
-    /**
-     * Creates an instance of the {@link module:media-embed/mediaregistry~MediaRegistry} class.
-     *
-     * @param locale The localization services instance.
-     * @param config The configuration of the media embed feature.
-     */
-    constructor(locale: Locale, config: MediaEmbedConfig);
-    /**
-     * Checks whether the passed URL is representing a certain media type allowed in the editor.
-     *
-     * @param url The URL to be checked
-     */
-    hasMedia(url: string): boolean;
-    /**
-     * For the given media URL string and options, it returns the {@link module:engine/view/element~Element view element}
-     * representing that media.
-     *
-     * **Note:** If no URL is specified, an empty view element is returned.
-     *
-     * @param writer The view writer used to produce a view element.
-     * @param url The URL to be translated into a view element.
-     */
-    getMediaViewElement(writer: DowncastWriter, url: string, options: MediaOptions): ViewElement;
-    /**
-     * Returns a `Media` instance for the given URL.
-     *
-     * @param url The URL of the media.
-     * @returns The `Media` instance or `null` when there is none.
-     */
-    private _getMedia;
-    /**
-     * Tries to match `url` to `pattern`.
-     *
-     * @param url The URL of the media.
-     * @param pattern The pattern that should accept the media URL.
-     */
-    private _getUrlMatches;
-}
+/**
+ * @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 media-embed/mediaregistry
+ */
+import type { DowncastWriter, ViewElement } from 'ckeditor5/src/engine.js';
+import { type Locale } from 'ckeditor5/src/utils.js';
+import type { MediaEmbedConfig, MediaEmbedProvider } from './mediaembedconfig.js';
+import type { MediaOptions } from './utils.js';
+/**
+ * A bridge between the raw media content provider definitions and the editor view content.
+ *
+ * It helps translating media URLs to corresponding {@link module:engine/view/element~Element view elements}.
+ *
+ * Mostly used by the {@link module:media-embed/mediaembedediting~MediaEmbedEditing} plugin.
+ */
+export default class MediaRegistry {
+    /**
+     * The {@link module:utils/locale~Locale} instance.
+     */
+    locale: Locale;
+    /**
+     * The media provider definitions available for the registry. Usually corresponding with the
+     * {@link module:media-embed/mediaembedconfig~MediaEmbedConfig media configuration}.
+     */
+    providerDefinitions: Array<MediaEmbedProvider>;
+    /**
+     * Creates an instance of the {@link module:media-embed/mediaregistry~MediaRegistry} class.
+     *
+     * @param locale The localization services instance.
+     * @param config The configuration of the media embed feature.
+     */
+    constructor(locale: Locale, config: MediaEmbedConfig);
+    /**
+     * Checks whether the passed URL is representing a certain media type allowed in the editor.
+     *
+     * @param url The URL to be checked
+     */
+    hasMedia(url: string): boolean;
+    /**
+     * For the given media URL string and options, it returns the {@link module:engine/view/element~Element view element}
+     * representing that media.
+     *
+     * **Note:** If no URL is specified, an empty view element is returned.
+     *
+     * @param writer The view writer used to produce a view element.
+     * @param url The URL to be translated into a view element.
+     */
+    getMediaViewElement(writer: DowncastWriter, url: string, options: MediaOptions): ViewElement;
+    /**
+     * Returns a `Media` instance for the given URL.
+     *
+     * @param url The URL of the media.
+     * @returns The `Media` instance or `null` when there is none.
+     */
+    private _getMedia;
+    /**
+     * Tries to match `url` to `pattern`.
+     *
+     * @param url The URL of the media.
+     * @param pattern The pattern that should accept the media URL.
+     */
+    private _getUrlMatches;
+}