@ckeditor/ckeditor5-ui 39.0.1 → 40.0.0

package/src/colorselector/documentcolorcollection.js

@@ -1,42 +1,42 @@
-/**
- * @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 { Collection, ObservableMixin } from '@ckeditor/ckeditor5-utils';
-/**
- * A collection to store document colors. It enforces colors to be unique.
- */
-export default class DocumentColorCollection extends ObservableMixin((Collection)) {
-    constructor(options) {
-        super(options);
-        this.set('isEmpty', true);
-        this.on('change', () => {
-            this.set('isEmpty', this.length === 0);
-        });
-    }
-    /**
-     * Adds a color to the document color collection.
-     *
-     * This method ensures that no color duplicates are inserted (compared using
-     * the color value of the {@link module:ui/colorgrid/colorgridview~ColorDefinition}).
-     *
-     * If the item does not have an ID, it will be automatically generated and set on the item.
-     *
-     * @param index The position of the item in the collection. The item is pushed to the collection when `index` is not specified.
-     * @fires add
-     * @fires change
-     */
-    add(item, index) {
-        if (this.find(element => element.color === item.color)) {
-            // No duplicates are allowed.
-            return this;
-        }
-        return super.add(item, index);
-    }
-    /**
-     * Checks if an object with given colors is present in the document color collection.
-     */
-    hasColor(color) {
-        return !!this.find(item => item.color === color);
-    }
-}
+/**
+ * @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 { Collection, ObservableMixin } from '@ckeditor/ckeditor5-utils';
+/**
+ * A collection to store document colors. It enforces colors to be unique.
+ */
+export default class DocumentColorCollection extends ObservableMixin((Collection)) {
+    constructor(options) {
+        super(options);
+        this.set('isEmpty', true);
+        this.on('change', () => {
+            this.set('isEmpty', this.length === 0);
+        });
+    }
+    /**
+     * Adds a color to the document color collection.
+     *
+     * This method ensures that no color duplicates are inserted (compared using
+     * the color value of the {@link module:ui/colorgrid/colorgridview~ColorDefinition}).
+     *
+     * If the item does not have an ID, it will be automatically generated and set on the item.
+     *
+     * @param index The position of the item in the collection. The item is pushed to the collection when `index` is not specified.
+     * @fires add
+     * @fires change
+     */
+    add(item, index) {
+        if (this.find(element => element.color === item.color)) {
+            // No duplicates are allowed.
+            return this;
+        }
+        return super.add(item, index);
+    }
+    /**
+     * Checks if an object with given colors is present in the document color collection.
+     */
+    hasColor(color) {
+        return !!this.find(item => item.color === color);
+    }
+}

package/src/componentfactory.d.ts

@@ -1,81 +1,81 @@
-/**
- * @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 ui/componentfactory
- */
-import { type Locale } from '@ckeditor/ckeditor5-utils';
-import type { Editor } from '@ckeditor/ckeditor5-core';
-import type View from './view';
-/**
- * A helper class implementing the UI component ({@link module:ui/view~View view}) factory.
- *
- * It allows functions producing specific UI components to be registered under their unique names
- * in the factory. A registered component can be then instantiated by providing its name.
- * Note that the names are case insensitive.
- *
- * ```ts
- * // The editor provides localization tools for the factory.
- * const factory = new ComponentFactory( editor );
- *
- * factory.add( 'foo', locale => new FooView( locale ) );
- * factory.add( 'bar', locale => new BarView( locale ) );
- *
- * // An instance of FooView.
- * const fooInstance = factory.create( 'foo' );
- *
- * // Names are case insensitive so this is also allowed:
- * const barInstance = factory.create( 'Bar' );
- * ```
- *
- * The {@link module:core/editor/editor~Editor#locale editor locale} is passed to the factory
- * function when {@link module:ui/componentfactory~ComponentFactory#create} is called.
- */
-export default class ComponentFactory {
-    /**
-     * The editor instance that the factory belongs to.
-     */
-    readonly editor: Editor;
-    /**
-     * Registered component factories.
-     */
-    private readonly _components;
-    /**
-     * Creates an instance of the factory.
-     *
-     * @param editor The editor instance.
-     */
-    constructor(editor: Editor);
-    /**
-     * Returns an iterator of registered component names. Names are returned in lower case.
-     */
-    names(): IterableIterator<string>;
-    /**
-     * Registers a component factory function that will be used by the
-     * {@link #create create} method and called with the
-     * {@link module:core/editor/editor~Editor#locale editor locale} as an argument,
-     * allowing localization of the {@link module:ui/view~View view}.
-     *
-     * @param name The name of the component.
-     * @param callback The callback that returns the component.
-     */
-    add(name: string, callback: (locale: Locale) => View): void;
-    /**
-     * Creates an instance of a component registered in the factory under a specific name.
-     *
-     * When called, the {@link module:core/editor/editor~Editor#locale editor locale} is passed to
-     * the previously {@link #add added} factory function, allowing localization of the
-     * {@link module:ui/view~View view}.
-     *
-     * @param name The name of the component.
-     * @returns The instantiated component view.
-     */
-    create(name: string): View;
-    /**
-     * Checks if a component of a given name is registered in the factory.
-     *
-     * @param name The name of the component.
-     */
-    has(name: string): boolean;
-}
+/**
+ * @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 ui/componentfactory
+ */
+import { type Locale } from '@ckeditor/ckeditor5-utils';
+import type { Editor } from '@ckeditor/ckeditor5-core';
+import type View from './view';
+/**
+ * A helper class implementing the UI component ({@link module:ui/view~View view}) factory.
+ *
+ * It allows functions producing specific UI components to be registered under their unique names
+ * in the factory. A registered component can be then instantiated by providing its name.
+ * Note that the names are case insensitive.
+ *
+ * ```ts
+ * // The editor provides localization tools for the factory.
+ * const factory = new ComponentFactory( editor );
+ *
+ * factory.add( 'foo', locale => new FooView( locale ) );
+ * factory.add( 'bar', locale => new BarView( locale ) );
+ *
+ * // An instance of FooView.
+ * const fooInstance = factory.create( 'foo' );
+ *
+ * // Names are case insensitive so this is also allowed:
+ * const barInstance = factory.create( 'Bar' );
+ * ```
+ *
+ * The {@link module:core/editor/editor~Editor#locale editor locale} is passed to the factory
+ * function when {@link module:ui/componentfactory~ComponentFactory#create} is called.
+ */
+export default class ComponentFactory {
+    /**
+     * The editor instance that the factory belongs to.
+     */
+    readonly editor: Editor;
+    /**
+     * Registered component factories.
+     */
+    private readonly _components;
+    /**
+     * Creates an instance of the factory.
+     *
+     * @param editor The editor instance.
+     */
+    constructor(editor: Editor);
+    /**
+     * Returns an iterator of registered component names. Names are returned in lower case.
+     */
+    names(): IterableIterator<string>;
+    /**
+     * Registers a component factory function that will be used by the
+     * {@link #create create} method and called with the
+     * {@link module:core/editor/editor~Editor#locale editor locale} as an argument,
+     * allowing localization of the {@link module:ui/view~View view}.
+     *
+     * @param name The name of the component.
+     * @param callback The callback that returns the component.
+     */
+    add(name: string, callback: (locale: Locale) => View): void;
+    /**
+     * Creates an instance of a component registered in the factory under a specific name.
+     *
+     * When called, the {@link module:core/editor/editor~Editor#locale editor locale} is passed to
+     * the previously {@link #add added} factory function, allowing localization of the
+     * {@link module:ui/view~View view}.
+     *
+     * @param name The name of the component.
+     * @returns The instantiated component view.
+     */
+    create(name: string): View;
+    /**
+     * Checks if a component of a given name is registered in the factory.
+     *
+     * @param name The name of the component.
+     */
+    has(name: string): boolean;
+}

package/src/componentfactory.js

@@ -1,104 +1,104 @@
-/**
- * @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 ui/componentfactory
- */
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-/**
- * A helper class implementing the UI component ({@link module:ui/view~View view}) factory.
- *
- * It allows functions producing specific UI components to be registered under their unique names
- * in the factory. A registered component can be then instantiated by providing its name.
- * Note that the names are case insensitive.
- *
- * ```ts
- * // The editor provides localization tools for the factory.
- * const factory = new ComponentFactory( editor );
- *
- * factory.add( 'foo', locale => new FooView( locale ) );
- * factory.add( 'bar', locale => new BarView( locale ) );
- *
- * // An instance of FooView.
- * const fooInstance = factory.create( 'foo' );
- *
- * // Names are case insensitive so this is also allowed:
- * const barInstance = factory.create( 'Bar' );
- * ```
- *
- * The {@link module:core/editor/editor~Editor#locale editor locale} is passed to the factory
- * function when {@link module:ui/componentfactory~ComponentFactory#create} is called.
- */
-export default class ComponentFactory {
-    /**
-     * Creates an instance of the factory.
-     *
-     * @param editor The editor instance.
-     */
-    constructor(editor) {
-        /**
-         * Registered component factories.
-         */
-        this._components = new Map();
-        this.editor = editor;
-    }
-    /**
-     * Returns an iterator of registered component names. Names are returned in lower case.
-     */
-    *names() {
-        for (const value of this._components.values()) {
-            yield value.originalName;
-        }
-    }
-    /**
-     * Registers a component factory function that will be used by the
-     * {@link #create create} method and called with the
-     * {@link module:core/editor/editor~Editor#locale editor locale} as an argument,
-     * allowing localization of the {@link module:ui/view~View view}.
-     *
-     * @param name The name of the component.
-     * @param callback The callback that returns the component.
-     */
-    add(name, callback) {
-        this._components.set(getNormalized(name), { callback, originalName: name });
-    }
-    /**
-     * Creates an instance of a component registered in the factory under a specific name.
-     *
-     * When called, the {@link module:core/editor/editor~Editor#locale editor locale} is passed to
-     * the previously {@link #add added} factory function, allowing localization of the
-     * {@link module:ui/view~View view}.
-     *
-     * @param name The name of the component.
-     * @returns The instantiated component view.
-     */
-    create(name) {
-        if (!this.has(name)) {
-            /**
-             * The required component is not registered in the component factory. Please make sure
-             * the provided name is correct and the component has been correctly
-             * {@link module:ui/componentfactory~ComponentFactory#add added} to the factory.
-             *
-             * @error componentfactory-item-missing
-             * @param name The name of the missing component.
-             */
-            throw new CKEditorError('componentfactory-item-missing', this, { name });
-        }
-        return this._components.get(getNormalized(name)).callback(this.editor.locale);
-    }
-    /**
-     * Checks if a component of a given name is registered in the factory.
-     *
-     * @param name The name of the component.
-     */
-    has(name) {
-        return this._components.has(getNormalized(name));
-    }
-}
-/**
- * Ensures that the component name used as the key in the internal map is in lower case.
- */
-function getNormalized(name) {
-    return String(name).toLowerCase();
-}
+/**
+ * @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 ui/componentfactory
+ */
+import { CKEditorError } from '@ckeditor/ckeditor5-utils';
+/**
+ * A helper class implementing the UI component ({@link module:ui/view~View view}) factory.
+ *
+ * It allows functions producing specific UI components to be registered under their unique names
+ * in the factory. A registered component can be then instantiated by providing its name.
+ * Note that the names are case insensitive.
+ *
+ * ```ts
+ * // The editor provides localization tools for the factory.
+ * const factory = new ComponentFactory( editor );
+ *
+ * factory.add( 'foo', locale => new FooView( locale ) );
+ * factory.add( 'bar', locale => new BarView( locale ) );
+ *
+ * // An instance of FooView.
+ * const fooInstance = factory.create( 'foo' );
+ *
+ * // Names are case insensitive so this is also allowed:
+ * const barInstance = factory.create( 'Bar' );
+ * ```
+ *
+ * The {@link module:core/editor/editor~Editor#locale editor locale} is passed to the factory
+ * function when {@link module:ui/componentfactory~ComponentFactory#create} is called.
+ */
+export default class ComponentFactory {
+    /**
+     * Creates an instance of the factory.
+     *
+     * @param editor The editor instance.
+     */
+    constructor(editor) {
+        /**
+         * Registered component factories.
+         */
+        this._components = new Map();
+        this.editor = editor;
+    }
+    /**
+     * Returns an iterator of registered component names. Names are returned in lower case.
+     */
+    *names() {
+        for (const value of this._components.values()) {
+            yield value.originalName;
+        }
+    }
+    /**
+     * Registers a component factory function that will be used by the
+     * {@link #create create} method and called with the
+     * {@link module:core/editor/editor~Editor#locale editor locale} as an argument,
+     * allowing localization of the {@link module:ui/view~View view}.
+     *
+     * @param name The name of the component.
+     * @param callback The callback that returns the component.
+     */
+    add(name, callback) {
+        this._components.set(getNormalized(name), { callback, originalName: name });
+    }
+    /**
+     * Creates an instance of a component registered in the factory under a specific name.
+     *
+     * When called, the {@link module:core/editor/editor~Editor#locale editor locale} is passed to
+     * the previously {@link #add added} factory function, allowing localization of the
+     * {@link module:ui/view~View view}.
+     *
+     * @param name The name of the component.
+     * @returns The instantiated component view.
+     */
+    create(name) {
+        if (!this.has(name)) {
+            /**
+             * The required component is not registered in the component factory. Please make sure
+             * the provided name is correct and the component has been correctly
+             * {@link module:ui/componentfactory~ComponentFactory#add added} to the factory.
+             *
+             * @error componentfactory-item-missing
+             * @param name The name of the missing component.
+             */
+            throw new CKEditorError('componentfactory-item-missing', this, { name });
+        }
+        return this._components.get(getNormalized(name)).callback(this.editor.locale);
+    }
+    /**
+     * Checks if a component of a given name is registered in the factory.
+     *
+     * @param name The name of the component.
+     */
+    has(name) {
+        return this._components.has(getNormalized(name));
+    }
+}
+/**
+ * Ensures that the component name used as the key in the internal map is in lower case.
+ */
+function getNormalized(name) {
+    return String(name).toLowerCase();
+}

package/src/dropdown/button/dropdownbutton.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 ui/dropdown/button/dropdownbutton
- */
-import type Button from '../../button/button';
-import type ViewCollection from '../../viewcollection';
-/**
- * The dropdown button interface.
- */
-export default interface DropdownButton extends Button {
-    children: ViewCollection;
-}
-/**
- * Fired when the dropdown should be opened.
- * It will not be fired when the button {@link module:ui/dropdown/button/dropdownbutton~DropdownButton#isEnabled is disabled}.
- *
- * @eventName ~DropdownButton#open
- */
-export type DropdownButtonOpenEvent = {
-    name: 'open';
-    args: [];
-};
+/**
+ * @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 ui/dropdown/button/dropdownbutton
+ */
+import type Button from '../../button/button';
+import type ViewCollection from '../../viewcollection';
+/**
+ * The dropdown button interface.
+ */
+export default interface DropdownButton extends Button {
+    children: ViewCollection;
+}
+/**
+ * Fired when the dropdown should be opened.
+ * It will not be fired when the button {@link module:ui/dropdown/button/dropdownbutton~DropdownButton#isEnabled is disabled}.
+ *
+ * @eventName ~DropdownButton#open
+ */
+export type DropdownButtonOpenEvent = {
+    name: 'open';
+    args: [];
+};

package/src/dropdown/button/dropdownbutton.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/dropdown/button/dropdownbuttonview.d.ts

@@ -1,48 +1,48 @@
-/**
- * @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 ui/dropdown/button/dropdownbuttonview
- */
-import ButtonView from '../../button/buttonview';
-import type DropdownButton from './dropdownbutton';
-import IconView from '../../icon/iconview';
-import type { Locale } from '@ckeditor/ckeditor5-utils';
-/**
- * The default dropdown button view class.
- *
- * ```ts
- * const view = new DropdownButtonView();
- *
- * view.set( {
- * 	label: 'A button',
- * 	keystroke: 'Ctrl+B',
- * 	tooltip: true
- * } );
- *
- * view.render();
- *
- * document.body.append( view.element );
- * ```
- *
- * Also see the {@link module:ui/dropdown/utils~createDropdown `createDropdown()` util}.
- */
-export default class DropdownButtonView extends ButtonView implements DropdownButton {
-    /**
-     * An icon that displays arrow to indicate a dropdown button.
-     */
-    readonly arrowView: IconView;
-    /**
-     * @inheritDoc
-     */
-    constructor(locale?: Locale);
-    /**
-     * @inheritDoc
-     */
-    render(): void;
-    /**
-     * Creates a {@link module:ui/icon/iconview~IconView} instance as {@link #arrowView}.
-     */
-    private _createArrowView;
-}
+/**
+ * @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 ui/dropdown/button/dropdownbuttonview
+ */
+import ButtonView from '../../button/buttonview';
+import type DropdownButton from './dropdownbutton';
+import IconView from '../../icon/iconview';
+import type { Locale } from '@ckeditor/ckeditor5-utils';
+/**
+ * The default dropdown button view class.
+ *
+ * ```ts
+ * const view = new DropdownButtonView();
+ *
+ * view.set( {
+ * 	label: 'A button',
+ * 	keystroke: 'Ctrl+B',
+ * 	tooltip: true
+ * } );
+ *
+ * view.render();
+ *
+ * document.body.append( view.element );
+ * ```
+ *
+ * Also see the {@link module:ui/dropdown/utils~createDropdown `createDropdown()` util}.
+ */
+export default class DropdownButtonView extends ButtonView implements DropdownButton {
+    /**
+     * An icon that displays arrow to indicate a dropdown button.
+     */
+    readonly arrowView: IconView;
+    /**
+     * @inheritDoc
+     */
+    constructor(locale?: Locale);
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * Creates a {@link module:ui/icon/iconview~IconView} instance as {@link #arrowView}.
+     */
+    private _createArrowView;
+}