@ckeditor/ckeditor5-ui 38.1.0 → 38.1.1

package/src/colorpicker/utils.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 ui/colorpicker/utils
- */
-/* eslint-disable @typescript-eslint/ban-ts-comment */
-// There are no available types for 'color-parse' module.
-// @ts-ignore
-import { default as parse } from 'color-parse';
-import * as convert from 'color-convert';
-/**
- * Parses and converts the color string to requested format. Handles variety of color spaces
- * like `hsl`, `hex` or `rgb`.
- *
- * @param color
- * @returns A color string.
- */
-export function convertColor(color, outputFormat) {
-    if (!color) {
-        return '';
-    }
-    const colorObject = parseColorString(color);
-    if (!colorObject) {
-        return '';
-    }
-    if (colorObject.space === outputFormat) {
-        return color;
-    }
-    if (!canConvertParsedColor(colorObject)) {
-        return '';
-    }
-    const fromColorSpace = convert[colorObject.space];
-    const toColorSpace = fromColorSpace[outputFormat];
-    if (!toColorSpace) {
-        return '';
-    }
-    const convertedColorChannels = toColorSpace(colorObject.space === 'hex' ? colorObject.hexValue : colorObject.values);
-    return formatColorOutput(convertedColorChannels, outputFormat);
-}
-/**
- * Converts a color string to hex format.
- *
- * @param color
- * @returns A color string.
- */
-export function convertToHex(color) {
-    if (!color) {
-        return '';
-    }
-    const colorObject = parseColorString(color);
-    if (!colorObject) {
-        return '#000';
-    }
-    if (colorObject.space === 'hex') {
-        return colorObject.hexValue;
-    }
-    return convertColor(color, 'hex');
-}
-/**
- * Formats the passed color channels according to the requested format.
- *
- * @param values
- * @param format
- * @returns A color string.
- */
-function formatColorOutput(values, format) {
-    switch (format) {
-        case 'hex': return `#${values}`;
-        case 'rgb': return `rgb( ${values[0]}, ${values[1]}, ${values[2]} )`;
-        case 'hsl': return `hsl( ${values[0]}, ${values[1]}%, ${values[2]}% )`;
-        case 'hwb': return `hwb( ${values[0]}, ${values[1]}, ${values[2]} )`;
-        case 'lab': return `lab( ${values[0]}% ${values[1]} ${values[2]} )`;
-        case 'lch': return `lch( ${values[0]}% ${values[1]} ${values[2]} )`;
-        default: return '';
-    }
-}
-function parseColorString(colorString) {
-    // Parser library treats `hex` format as belonging to `rgb` space | which messes up further conversion.
-    // Let's parse such strings on our own.
-    if (colorString.startsWith('#')) {
-        const parsedHex = parse(colorString);
-        return {
-            space: 'hex',
-            values: parsedHex.values,
-            hexValue: colorString,
-            alpha: parsedHex.alpha
-        };
-    }
-    const parsed = parse(colorString);
-    if (!parsed.space) {
-        return null;
-    }
-    return parsed;
-}
-function canConvertParsedColor(parsedColor) {
-    return Object.keys(convert).includes(parsedColor.space);
-}
+/**
+ * @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/colorpicker/utils
+ */
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+// There are no available types for 'color-parse' module.
+// @ts-ignore
+import { default as parse } from 'color-parse';
+import * as convert from 'color-convert';
+/**
+ * Parses and converts the color string to requested format. Handles variety of color spaces
+ * like `hsl`, `hex` or `rgb`.
+ *
+ * @param color
+ * @returns A color string.
+ */
+export function convertColor(color, outputFormat) {
+    if (!color) {
+        return '';
+    }
+    const colorObject = parseColorString(color);
+    if (!colorObject) {
+        return '';
+    }
+    if (colorObject.space === outputFormat) {
+        return color;
+    }
+    if (!canConvertParsedColor(colorObject)) {
+        return '';
+    }
+    const fromColorSpace = convert[colorObject.space];
+    const toColorSpace = fromColorSpace[outputFormat];
+    if (!toColorSpace) {
+        return '';
+    }
+    const convertedColorChannels = toColorSpace(colorObject.space === 'hex' ? colorObject.hexValue : colorObject.values);
+    return formatColorOutput(convertedColorChannels, outputFormat);
+}
+/**
+ * Converts a color string to hex format.
+ *
+ * @param color
+ * @returns A color string.
+ */
+export function convertToHex(color) {
+    if (!color) {
+        return '';
+    }
+    const colorObject = parseColorString(color);
+    if (!colorObject) {
+        return '#000';
+    }
+    if (colorObject.space === 'hex') {
+        return colorObject.hexValue;
+    }
+    return convertColor(color, 'hex');
+}
+/**
+ * Formats the passed color channels according to the requested format.
+ *
+ * @param values
+ * @param format
+ * @returns A color string.
+ */
+function formatColorOutput(values, format) {
+    switch (format) {
+        case 'hex': return `#${values}`;
+        case 'rgb': return `rgb( ${values[0]}, ${values[1]}, ${values[2]} )`;
+        case 'hsl': return `hsl( ${values[0]}, ${values[1]}%, ${values[2]}% )`;
+        case 'hwb': return `hwb( ${values[0]}, ${values[1]}, ${values[2]} )`;
+        case 'lab': return `lab( ${values[0]}% ${values[1]} ${values[2]} )`;
+        case 'lch': return `lch( ${values[0]}% ${values[1]} ${values[2]} )`;
+        default: return '';
+    }
+}
+function parseColorString(colorString) {
+    // Parser library treats `hex` format as belonging to `rgb` space | which messes up further conversion.
+    // Let's parse such strings on our own.
+    if (colorString.startsWith('#')) {
+        const parsedHex = parse(colorString);
+        return {
+            space: 'hex',
+            values: parsedHex.values,
+            hexValue: colorString,
+            alpha: parsedHex.alpha
+        };
+    }
+    const parsed = parse(colorString);
+    if (!parsed.space) {
+        return null;
+    }
+    return parsed;
+}
+function canConvertParsedColor(parsedColor) {
+    return Object.keys(convert).includes(parsedColor.space);
+}

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 {};