@ckeditor/ckeditor5-font 39.0.2 → 40.0.0

package/src/fontsize/fontsizeui.js

@@ -1,122 +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 font/fontsize/fontsizeui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Model, createDropdown, addListToDropdown } from 'ckeditor5/src/ui';
-import { Collection } from 'ckeditor5/src/utils';
-import { normalizeOptions } from './utils';
-import { FONT_SIZE } from '../utils';
-import '../../theme/fontsize.css';
-import fontSizeIcon from '../../theme/icons/font-size.svg';
-/**
- * The font size UI plugin. It introduces the `'fontSize'` dropdown.
- */
-export default class FontSizeUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'FontSizeUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const t = editor.t;
-        const options = this._getLocalizedOptions();
-        const command = editor.commands.get(FONT_SIZE);
-        const accessibleLabel = t('Font Size');
-        // Register UI component.
-        editor.ui.componentFactory.add(FONT_SIZE, locale => {
-            const dropdownView = createDropdown(locale);
-            addListToDropdown(dropdownView, () => _prepareListOptions(options, command), {
-                role: 'menu',
-                ariaLabel: accessibleLabel
-            });
-            // Create dropdown model.
-            dropdownView.buttonView.set({
-                label: accessibleLabel,
-                icon: fontSizeIcon,
-                tooltip: true
-            });
-            dropdownView.extendTemplate({
-                attributes: {
-                    class: [
-                        'ck-font-size-dropdown'
-                    ]
-                }
-            });
-            dropdownView.bind('isEnabled').to(command);
-            // Execute command when an item from the dropdown is selected.
-            this.listenTo(dropdownView, 'execute', evt => {
-                editor.execute(evt.source.commandName, { value: evt.source.commandParam });
-                editor.editing.view.focus();
-            });
-            return dropdownView;
-        });
-    }
-    /**
-     * Returns options as defined in `config.fontSize.options` but processed to account for
-     * editor localization, i.e. to display {@link module:font/fontconfig~FontSizeOption}
-     * in the correct language.
-     *
-     * Note: The reason behind this method is that there is no way to use {@link module:utils/locale~Locale#t}
-     * when the user configuration is defined because the editor does not exist yet.
-     */
-    _getLocalizedOptions() {
-        const editor = this.editor;
-        const t = editor.t;
-        const localizedTitles = {
-            Default: t('Default'),
-            Tiny: t('Tiny'),
-            Small: t('Small'),
-            Big: t('Big'),
-            Huge: t('Huge')
-        };
-        const options = normalizeOptions((editor.config.get(FONT_SIZE)).options);
-        return options.map(option => {
-            const title = localizedTitles[option.title];
-            if (title && title != option.title) {
-                // Clone the option to avoid altering the original `namedPresets` from `./utils.js`.
-                option = Object.assign({}, option, { title });
-            }
-            return option;
-        });
-    }
-}
-/**
- * Prepares FontSize dropdown items.
- */
-function _prepareListOptions(options, command) {
-    const itemDefinitions = new Collection();
-    for (const option of options) {
-        const def = {
-            type: 'button',
-            model: new Model({
-                commandName: FONT_SIZE,
-                commandParam: option.model,
-                label: option.title,
-                class: 'ck-fontsize-option',
-                role: 'menuitemradio',
-                withText: true
-            })
-        };
-        if (option.view && typeof option.view !== 'string') {
-            if (option.view.styles) {
-                def.model.set('labelStyle', `font-size:${option.view.styles['font-size']}`);
-            }
-            if (option.view.classes) {
-                def.model.set('class', `${def.model.class} ${option.view.classes}`);
-            }
-        }
-        def.model.bind('isOn').to(command, 'value', value => value === option.model);
-        // Add the option to the collection.
-        itemDefinitions.add(def);
-    }
-    return itemDefinitions;
-}
+/**
+ * @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 font/fontsize/fontsizeui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Model, createDropdown, addListToDropdown } from 'ckeditor5/src/ui';
+import { Collection } from 'ckeditor5/src/utils';
+import { normalizeOptions } from './utils';
+import { FONT_SIZE } from '../utils';
+import '../../theme/fontsize.css';
+import fontSizeIcon from '../../theme/icons/font-size.svg';
+/**
+ * The font size UI plugin. It introduces the `'fontSize'` dropdown.
+ */
+export default class FontSizeUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'FontSizeUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        const options = this._getLocalizedOptions();
+        const command = editor.commands.get(FONT_SIZE);
+        const accessibleLabel = t('Font Size');
+        // Register UI component.
+        editor.ui.componentFactory.add(FONT_SIZE, locale => {
+            const dropdownView = createDropdown(locale);
+            addListToDropdown(dropdownView, () => _prepareListOptions(options, command), {
+                role: 'menu',
+                ariaLabel: accessibleLabel
+            });
+            // Create dropdown model.
+            dropdownView.buttonView.set({
+                label: accessibleLabel,
+                icon: fontSizeIcon,
+                tooltip: true
+            });
+            dropdownView.extendTemplate({
+                attributes: {
+                    class: [
+                        'ck-font-size-dropdown'
+                    ]
+                }
+            });
+            dropdownView.bind('isEnabled').to(command);
+            // Execute command when an item from the dropdown is selected.
+            this.listenTo(dropdownView, 'execute', evt => {
+                editor.execute(evt.source.commandName, { value: evt.source.commandParam });
+                editor.editing.view.focus();
+            });
+            return dropdownView;
+        });
+    }
+    /**
+     * Returns options as defined in `config.fontSize.options` but processed to account for
+     * editor localization, i.e. to display {@link module:font/fontconfig~FontSizeOption}
+     * in the correct language.
+     *
+     * Note: The reason behind this method is that there is no way to use {@link module:utils/locale~Locale#t}
+     * when the user configuration is defined because the editor does not exist yet.
+     */
+    _getLocalizedOptions() {
+        const editor = this.editor;
+        const t = editor.t;
+        const localizedTitles = {
+            Default: t('Default'),
+            Tiny: t('Tiny'),
+            Small: t('Small'),
+            Big: t('Big'),
+            Huge: t('Huge')
+        };
+        const options = normalizeOptions((editor.config.get(FONT_SIZE)).options);
+        return options.map(option => {
+            const title = localizedTitles[option.title];
+            if (title && title != option.title) {
+                // Clone the option to avoid altering the original `namedPresets` from `./utils.js`.
+                option = Object.assign({}, option, { title });
+            }
+            return option;
+        });
+    }
+}
+/**
+ * Prepares FontSize dropdown items.
+ */
+function _prepareListOptions(options, command) {
+    const itemDefinitions = new Collection();
+    for (const option of options) {
+        const def = {
+            type: 'button',
+            model: new Model({
+                commandName: FONT_SIZE,
+                commandParam: option.model,
+                label: option.title,
+                class: 'ck-fontsize-option',
+                role: 'menuitemradio',
+                withText: true
+            })
+        };
+        if (option.view && typeof option.view !== 'string') {
+            if (option.view.styles) {
+                def.model.set('labelStyle', `font-size:${option.view.styles['font-size']}`);
+            }
+            if (option.view.classes) {
+                def.model.set('class', `${def.model.class} ${option.view.classes}`);
+            }
+        }
+        def.model.bind('isOn').to(command, 'value', value => value === option.model);
+        // Add the option to the collection.
+        itemDefinitions.add(def);
+    }
+    return itemDefinitions;
+}

package/src/fontsize/utils.d.ts

@@ -1,12 +1,12 @@
-/**
- * @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 { type FontSizeOption } from '../fontconfig';
-/**
- * Normalizes and translates the {@link module:font/fontconfig~FontSizeConfig#options configuration options}
- * to the {@link module:font/fontconfig~FontSizeOption} format.
- *
- * @param configuredOptions An array of options taken from the configuration.
- */
-export declare function normalizeOptions(configuredOptions: Array<string | number | FontSizeOption>): Array<FontSizeOption>;
+/**
+ * @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 { type FontSizeOption } from '../fontconfig';
+/**
+ * Normalizes and translates the {@link module:font/fontconfig~FontSizeConfig#options configuration options}
+ * to the {@link module:font/fontconfig~FontSizeOption} format.
+ *
+ * @param configuredOptions An array of options taken from the configuration.
+ */
+export declare function normalizeOptions(configuredOptions: Array<string | number | FontSizeOption>): Array<FontSizeOption>;

package/src/fontsize/utils.js

@@ -1,166 +1,166 @@
-/**
- * @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 font/fontsize/utils
- */
-import { CKEditorError } from 'ckeditor5/src/utils';
-/**
- * Normalizes and translates the {@link module:font/fontconfig~FontSizeConfig#options configuration options}
- * to the {@link module:font/fontconfig~FontSizeOption} format.
- *
- * @param configuredOptions An array of options taken from the configuration.
- */
-export function normalizeOptions(configuredOptions) {
-    // Convert options to objects.
-    return configuredOptions
-        .map(item => getOptionDefinition(item))
-        // Filter out undefined values that `getOptionDefinition` might return.
-        .filter((option) => option !== undefined);
-}
-// Default named presets map. Always create a new instance of the preset object in order to avoid modifying references.
-const namedPresets = {
-    get tiny() {
-        return {
-            title: 'Tiny',
-            model: 'tiny',
-            view: {
-                name: 'span',
-                classes: 'text-tiny',
-                priority: 7
-            }
-        };
-    },
-    get small() {
-        return {
-            title: 'Small',
-            model: 'small',
-            view: {
-                name: 'span',
-                classes: 'text-small',
-                priority: 7
-            }
-        };
-    },
-    get big() {
-        return {
-            title: 'Big',
-            model: 'big',
-            view: {
-                name: 'span',
-                classes: 'text-big',
-                priority: 7
-            }
-        };
-    },
-    get huge() {
-        return {
-            title: 'Huge',
-            model: 'huge',
-            view: {
-                name: 'span',
-                classes: 'text-huge',
-                priority: 7
-            }
-        };
-    }
-};
-/**
- * Returns an option definition either from preset or creates one from number shortcut.
- * If object is passed then this method will return it without alternating it. Returns undefined for item than cannot be parsed.
- */
-function getOptionDefinition(option) {
-    if (typeof option === 'number') {
-        option = String(option);
-    }
-    // Check whether passed option is a full item definition provided by user in configuration.
-    if (typeof option === 'object' && isFullItemDefinition(option)) {
-        return attachPriority(option);
-    }
-    const preset = findPreset(option);
-    // Item is a named preset.
-    if (preset) {
-        return attachPriority(preset);
-    }
-    // 'Default' font size. It will be used to remove the fontSize attribute.
-    if (option === 'default') {
-        return {
-            model: undefined,
-            title: 'Default'
-        };
-    }
-    // At this stage we probably have numerical value to generate a preset so parse it's value.
-    // Discard any faulty values.
-    if (isNumericalDefinition(option)) {
-        return undefined;
-    }
-    // Return font size definition from size value.
-    return generatePixelPreset(option);
-}
-/**
- * Creates a predefined preset for pixel size.
- * @param definition Font size in pixels.
- * @returns
- */
-function generatePixelPreset(definition) {
-    // Extend a short (numeric value) definition.
-    if (typeof definition === 'string') {
-        definition = {
-            title: definition,
-            model: `${parseFloat(definition)}px`
-        };
-    }
-    definition.view = {
-        name: 'span',
-        styles: {
-            'font-size': definition.model
-        }
-    };
-    return attachPriority(definition);
-}
-/**
- * Adds the priority to the view element definition if missing. It's required due to ckeditor/ckeditor5#2291
- */
-function attachPriority(definition) {
-    if (definition.view && typeof definition.view !== 'string' && !definition.view.priority) {
-        definition.view.priority = 7;
-    }
-    return definition;
-}
-/**
- * Returns a prepared preset definition. If passed an object, a name of preset should be defined as `model` value.
- *
- * @param definition.model A preset name.
- */
-function findPreset(definition) {
-    return typeof definition === 'string' ? namedPresets[definition] : namedPresets[definition.model];
-}
-/**
- * We treat `definition` as completed if it is an object that contains `title`, `model` and `view` values.
- */
-function isFullItemDefinition(definition) {
-    return definition.title && definition.model && definition.view;
-}
-function isNumericalDefinition(definition) {
-    let numberValue;
-    if (typeof definition === 'object') {
-        if (!definition.model) {
-            /**
-             * Provided value as an option for {@link module:font/fontsize~FontSize} seems to invalid.
-             *
-             * See valid examples described in the {@link module:font/fontconfig~FontSizeConfig#options plugin configuration}.
-             *
-             * @error font-size-invalid-definition
-             */
-            throw new CKEditorError('font-size-invalid-definition', null, definition);
-        }
-        else {
-            numberValue = parseFloat(definition.model);
-        }
-    }
-    else {
-        numberValue = parseFloat(definition);
-    }
-    return isNaN(numberValue);
-}
+/**
+ * @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 font/fontsize/utils
+ */
+import { CKEditorError } from 'ckeditor5/src/utils';
+/**
+ * Normalizes and translates the {@link module:font/fontconfig~FontSizeConfig#options configuration options}
+ * to the {@link module:font/fontconfig~FontSizeOption} format.
+ *
+ * @param configuredOptions An array of options taken from the configuration.
+ */
+export function normalizeOptions(configuredOptions) {
+    // Convert options to objects.
+    return configuredOptions
+        .map(item => getOptionDefinition(item))
+        // Filter out undefined values that `getOptionDefinition` might return.
+        .filter((option) => option !== undefined);
+}
+// Default named presets map. Always create a new instance of the preset object in order to avoid modifying references.
+const namedPresets = {
+    get tiny() {
+        return {
+            title: 'Tiny',
+            model: 'tiny',
+            view: {
+                name: 'span',
+                classes: 'text-tiny',
+                priority: 7
+            }
+        };
+    },
+    get small() {
+        return {
+            title: 'Small',
+            model: 'small',
+            view: {
+                name: 'span',
+                classes: 'text-small',
+                priority: 7
+            }
+        };
+    },
+    get big() {
+        return {
+            title: 'Big',
+            model: 'big',
+            view: {
+                name: 'span',
+                classes: 'text-big',
+                priority: 7
+            }
+        };
+    },
+    get huge() {
+        return {
+            title: 'Huge',
+            model: 'huge',
+            view: {
+                name: 'span',
+                classes: 'text-huge',
+                priority: 7
+            }
+        };
+    }
+};
+/**
+ * Returns an option definition either from preset or creates one from number shortcut.
+ * If object is passed then this method will return it without alternating it. Returns undefined for item than cannot be parsed.
+ */
+function getOptionDefinition(option) {
+    if (typeof option === 'number') {
+        option = String(option);
+    }
+    // Check whether passed option is a full item definition provided by user in configuration.
+    if (typeof option === 'object' && isFullItemDefinition(option)) {
+        return attachPriority(option);
+    }
+    const preset = findPreset(option);
+    // Item is a named preset.
+    if (preset) {
+        return attachPriority(preset);
+    }
+    // 'Default' font size. It will be used to remove the fontSize attribute.
+    if (option === 'default') {
+        return {
+            model: undefined,
+            title: 'Default'
+        };
+    }
+    // At this stage we probably have numerical value to generate a preset so parse it's value.
+    // Discard any faulty values.
+    if (isNumericalDefinition(option)) {
+        return undefined;
+    }
+    // Return font size definition from size value.
+    return generatePixelPreset(option);
+}
+/**
+ * Creates a predefined preset for pixel size.
+ * @param definition Font size in pixels.
+ * @returns
+ */
+function generatePixelPreset(definition) {
+    // Extend a short (numeric value) definition.
+    if (typeof definition === 'string') {
+        definition = {
+            title: definition,
+            model: `${parseFloat(definition)}px`
+        };
+    }
+    definition.view = {
+        name: 'span',
+        styles: {
+            'font-size': definition.model
+        }
+    };
+    return attachPriority(definition);
+}
+/**
+ * Adds the priority to the view element definition if missing. It's required due to ckeditor/ckeditor5#2291
+ */
+function attachPriority(definition) {
+    if (definition.view && typeof definition.view !== 'string' && !definition.view.priority) {
+        definition.view.priority = 7;
+    }
+    return definition;
+}
+/**
+ * Returns a prepared preset definition. If passed an object, a name of preset should be defined as `model` value.
+ *
+ * @param definition.model A preset name.
+ */
+function findPreset(definition) {
+    return typeof definition === 'string' ? namedPresets[definition] : namedPresets[definition.model];
+}
+/**
+ * We treat `definition` as completed if it is an object that contains `title`, `model` and `view` values.
+ */
+function isFullItemDefinition(definition) {
+    return definition.title && definition.model && definition.view;
+}
+function isNumericalDefinition(definition) {
+    let numberValue;
+    if (typeof definition === 'object') {
+        if (!definition.model) {
+            /**
+             * Provided value as an option for {@link module:font/fontsize~FontSize} seems to invalid.
+             *
+             * See valid examples described in the {@link module:font/fontconfig~FontSizeConfig#options plugin configuration}.
+             *
+             * @error font-size-invalid-definition
+             */
+            throw new CKEditorError('font-size-invalid-definition', null, definition);
+        }
+        else {
+            numberValue = parseFloat(definition.model);
+        }
+    }
+    else {
+        numberValue = parseFloat(definition);
+    }
+    return isNaN(numberValue);
+}