@ckeditor/ckeditor5-font 39.0.2 → 40.0.0

package/src/fontfamily/fontfamilyui.js

@@ -1,114 +1,114 @@
-/**
- * @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/fontfamily/fontfamilyui
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { Collection } from 'ckeditor5/src/utils';
-import { Model, createDropdown, addListToDropdown } from 'ckeditor5/src/ui';
-import { normalizeOptions } from './utils';
-import { FONT_FAMILY } from '../utils';
-import fontFamilyIcon from '../../theme/icons/font-family.svg';
-/**
- * The font family UI plugin. It introduces the `'fontFamily'` dropdown.
- */
-export default class FontFamilyUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'FontFamilyUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const t = editor.t;
-        const options = this._getLocalizedOptions();
-        const command = editor.commands.get(FONT_FAMILY);
-        const accessibleLabel = t('Font Family');
-        // Register UI component.
-        editor.ui.componentFactory.add(FONT_FAMILY, locale => {
-            const dropdownView = createDropdown(locale);
-            addListToDropdown(dropdownView, () => _prepareListOptions(options, command), {
-                role: 'menu',
-                ariaLabel: accessibleLabel
-            });
-            dropdownView.buttonView.set({
-                label: accessibleLabel,
-                icon: fontFamilyIcon,
-                tooltip: true
-            });
-            dropdownView.extendTemplate({
-                attributes: {
-                    class: 'ck-font-family-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.fontFamily.options` but processed to account for
-     * editor localization, i.e. to display {@link module:font/fontconfig~FontFamilyOption}
-     * 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 options = normalizeOptions((editor.config.get(FONT_FAMILY)).options);
-        return options.map(option => {
-            // The only title to localize is "Default" others are font names.
-            if (option.title === 'Default') {
-                option.title = t('Default');
-            }
-            return option;
-        });
-    }
-}
-/**
- * Prepares FontFamily dropdown items.
- */
-function _prepareListOptions(options, command) {
-    const itemDefinitions = new Collection();
-    // Create dropdown items.
-    for (const option of options) {
-        const def = {
-            type: 'button',
-            model: new Model({
-                commandName: FONT_FAMILY,
-                commandParam: option.model,
-                label: option.title,
-                role: 'menuitemradio',
-                withText: true
-            })
-        };
-        def.model.bind('isOn').to(command, 'value', value => {
-            // "Default" or check in strict font-family converters mode.
-            if (value === option.model) {
-                return true;
-            }
-            if (!value || !option.model) {
-                return false;
-            }
-            return value.split(',')[0].replace(/'/g, '').toLowerCase() === option.model.toLowerCase();
-        });
-        // Try to set a dropdown list item style.
-        if (option.view && typeof option.view !== 'string' && option.view.styles) {
-            def.model.set('labelStyle', `font-family: ${option.view.styles['font-family']}`);
-        }
-        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/fontfamily/fontfamilyui
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { Collection } from 'ckeditor5/src/utils';
+import { Model, createDropdown, addListToDropdown } from 'ckeditor5/src/ui';
+import { normalizeOptions } from './utils';
+import { FONT_FAMILY } from '../utils';
+import fontFamilyIcon from '../../theme/icons/font-family.svg';
+/**
+ * The font family UI plugin. It introduces the `'fontFamily'` dropdown.
+ */
+export default class FontFamilyUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'FontFamilyUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const t = editor.t;
+        const options = this._getLocalizedOptions();
+        const command = editor.commands.get(FONT_FAMILY);
+        const accessibleLabel = t('Font Family');
+        // Register UI component.
+        editor.ui.componentFactory.add(FONT_FAMILY, locale => {
+            const dropdownView = createDropdown(locale);
+            addListToDropdown(dropdownView, () => _prepareListOptions(options, command), {
+                role: 'menu',
+                ariaLabel: accessibleLabel
+            });
+            dropdownView.buttonView.set({
+                label: accessibleLabel,
+                icon: fontFamilyIcon,
+                tooltip: true
+            });
+            dropdownView.extendTemplate({
+                attributes: {
+                    class: 'ck-font-family-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.fontFamily.options` but processed to account for
+     * editor localization, i.e. to display {@link module:font/fontconfig~FontFamilyOption}
+     * 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 options = normalizeOptions((editor.config.get(FONT_FAMILY)).options);
+        return options.map(option => {
+            // The only title to localize is "Default" others are font names.
+            if (option.title === 'Default') {
+                option.title = t('Default');
+            }
+            return option;
+        });
+    }
+}
+/**
+ * Prepares FontFamily dropdown items.
+ */
+function _prepareListOptions(options, command) {
+    const itemDefinitions = new Collection();
+    // Create dropdown items.
+    for (const option of options) {
+        const def = {
+            type: 'button',
+            model: new Model({
+                commandName: FONT_FAMILY,
+                commandParam: option.model,
+                label: option.title,
+                role: 'menuitemradio',
+                withText: true
+            })
+        };
+        def.model.bind('isOn').to(command, 'value', value => {
+            // "Default" or check in strict font-family converters mode.
+            if (value === option.model) {
+                return true;
+            }
+            if (!value || !option.model) {
+                return false;
+            }
+            return value.split(',')[0].replace(/'/g, '').toLowerCase() === option.model.toLowerCase();
+        });
+        // Try to set a dropdown list item style.
+        if (option.view && typeof option.view !== 'string' && option.view.styles) {
+            def.model.set('labelStyle', `font-family: ${option.view.styles['font-family']}`);
+        }
+        itemDefinitions.add(def);
+    }
+    return itemDefinitions;
+}

package/src/fontfamily/utils.d.ts

@@ -1,15 +1,15 @@
-/**
- * @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 { FontFamilyOption } from '../fontconfig';
-/**
- * @module font/fontfamily/utils
- */
-/**
- * Normalizes the {@link module:font/fontconfig~FontFamilyConfig#options configuration options}
- * to the {@link module:font/fontconfig~FontFamilyOption} format.
- *
- * @param configuredOptions An array of options taken from the configuration.
- */
-export declare function normalizeOptions(configuredOptions: Array<string | FontFamilyOption>): Array<FontFamilyOption>;
+/**
+ * @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 { FontFamilyOption } from '../fontconfig';
+/**
+ * @module font/fontfamily/utils
+ */
+/**
+ * Normalizes the {@link module:font/fontconfig~FontFamilyConfig#options configuration options}
+ * to the {@link module:font/fontconfig~FontFamilyOption} format.
+ *
+ * @param configuredOptions An array of options taken from the configuration.
+ */
+export declare function normalizeOptions(configuredOptions: Array<string | FontFamilyOption>): Array<FontFamilyOption>;

package/src/fontfamily/utils.js

@@ -1,80 +1,80 @@
-/**
- * @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/fontfamily/utils
- */
-/**
- * Normalizes the {@link module:font/fontconfig~FontFamilyConfig#options configuration options}
- * to the {@link module:font/fontconfig~FontFamilyOption} format.
- *
- * @param configuredOptions An array of options taken from the configuration.
- */
-export function normalizeOptions(configuredOptions) {
-    // Convert options to objects.
-    return configuredOptions
-        .map(getOptionDefinition)
-        // Filter out undefined values that `getOptionDefinition` might return.
-        .filter(option => option !== undefined);
-}
-/**
- * Returns an option definition either created from string 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) {
-    // Treat any object as full item definition provided by user in configuration.
-    if (typeof option === 'object') {
-        return option;
-    }
-    // Handle 'default' string as a special case. It will be used to remove the fontFamily attribute.
-    if (option === 'default') {
-        return {
-            title: 'Default',
-            model: undefined
-        };
-    }
-    // Ignore values that we cannot parse to a definition.
-    if (typeof option !== 'string') {
-        return undefined;
-    }
-    // Return font family definition from font string.
-    return generateFontPreset(option);
-}
-/**
- * Creates a predefined preset for pixel size. It deconstructs font-family like string into full configuration option.
- * A font definition is passed as coma delimited set of font family names. Font names might be quoted.
- *
- * @param fontDefinition A font definition form configuration.
- */
-function generateFontPreset(fontDefinition) {
-    // Remove quotes from font names. They will be normalized later.
-    const fontNames = fontDefinition.replace(/"|'/g, '').split(',');
-    // The first matched font name will be used as dropdown list item title and as model value.
-    const firstFontName = fontNames[0];
-    // CSS-compatible font names.
-    const cssFontNames = fontNames.map(normalizeFontNameForCSS).join(', ');
-    return {
-        title: firstFontName,
-        model: cssFontNames,
-        view: {
-            name: 'span',
-            styles: {
-                'font-family': cssFontNames
-            },
-            priority: 7
-        }
-    };
-}
-/**
- * Normalizes font name for the style attribute. It adds braces (') if font name contains spaces.
- */
-function normalizeFontNameForCSS(fontName) {
-    fontName = fontName.trim();
-    // Compound font names should be quoted.
-    if (fontName.indexOf(' ') > 0) {
-        fontName = `'${fontName}'`;
-    }
-    return fontName;
-}
+/**
+ * @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/fontfamily/utils
+ */
+/**
+ * Normalizes the {@link module:font/fontconfig~FontFamilyConfig#options configuration options}
+ * to the {@link module:font/fontconfig~FontFamilyOption} format.
+ *
+ * @param configuredOptions An array of options taken from the configuration.
+ */
+export function normalizeOptions(configuredOptions) {
+    // Convert options to objects.
+    return configuredOptions
+        .map(getOptionDefinition)
+        // Filter out undefined values that `getOptionDefinition` might return.
+        .filter(option => option !== undefined);
+}
+/**
+ * Returns an option definition either created from string 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) {
+    // Treat any object as full item definition provided by user in configuration.
+    if (typeof option === 'object') {
+        return option;
+    }
+    // Handle 'default' string as a special case. It will be used to remove the fontFamily attribute.
+    if (option === 'default') {
+        return {
+            title: 'Default',
+            model: undefined
+        };
+    }
+    // Ignore values that we cannot parse to a definition.
+    if (typeof option !== 'string') {
+        return undefined;
+    }
+    // Return font family definition from font string.
+    return generateFontPreset(option);
+}
+/**
+ * Creates a predefined preset for pixel size. It deconstructs font-family like string into full configuration option.
+ * A font definition is passed as coma delimited set of font family names. Font names might be quoted.
+ *
+ * @param fontDefinition A font definition form configuration.
+ */
+function generateFontPreset(fontDefinition) {
+    // Remove quotes from font names. They will be normalized later.
+    const fontNames = fontDefinition.replace(/"|'/g, '').split(',');
+    // The first matched font name will be used as dropdown list item title and as model value.
+    const firstFontName = fontNames[0];
+    // CSS-compatible font names.
+    const cssFontNames = fontNames.map(normalizeFontNameForCSS).join(', ');
+    return {
+        title: firstFontName,
+        model: cssFontNames,
+        view: {
+            name: 'span',
+            styles: {
+                'font-family': cssFontNames
+            },
+            priority: 7
+        }
+    };
+}
+/**
+ * Normalizes font name for the style attribute. It adds braces (') if font name contains spaces.
+ */
+function normalizeFontNameForCSS(fontName) {
+    fontName = fontName.trim();
+    // Compound font names should be quoted.
+    if (fontName.indexOf(' ') > 0) {
+        fontName = `'${fontName}'`;
+    }
+    return fontName;
+}

package/src/fontfamily.d.ts

@@ -1,29 +1,29 @@
-/**
- * @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/fontfamily
- */
-import { Plugin } from 'ckeditor5/src/core';
-import FontFamilyEditing from './fontfamily/fontfamilyediting';
-import FontFamilyUI from './fontfamily/fontfamilyui';
-/**
- * The font family plugin.
- *
- * For a detailed overview, check the {@glink features/font font feature} documentatiom
- * and the {@glink api/font package page}.
- *
- * This is a "glue" plugin which loads the {@link module:font/fontfamily/fontfamilyediting~FontFamilyEditing} and
- * {@link module:font/fontfamily/fontfamilyui~FontFamilyUI} features in the editor.
- */
-export default class FontFamily extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof FontFamilyEditing, typeof FontFamilyUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FontFamily";
-}
+/**
+ * @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/fontfamily
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import FontFamilyEditing from './fontfamily/fontfamilyediting';
+import FontFamilyUI from './fontfamily/fontfamilyui';
+/**
+ * The font family plugin.
+ *
+ * For a detailed overview, check the {@glink features/font font feature} documentatiom
+ * and the {@glink api/font package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:font/fontfamily/fontfamilyediting~FontFamilyEditing} and
+ * {@link module:font/fontfamily/fontfamilyui~FontFamilyUI} features in the editor.
+ */
+export default class FontFamily extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof FontFamilyEditing, typeof FontFamilyUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "FontFamily";
+}

package/src/fontfamily.js

@@ -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 font/fontfamily
- */
-import { Plugin } from 'ckeditor5/src/core';
-import FontFamilyEditing from './fontfamily/fontfamilyediting';
-import FontFamilyUI from './fontfamily/fontfamilyui';
-/**
- * The font family plugin.
- *
- * For a detailed overview, check the {@glink features/font font feature} documentatiom
- * and the {@glink api/font package page}.
- *
- * This is a "glue" plugin which loads the {@link module:font/fontfamily/fontfamilyediting~FontFamilyEditing} and
- * {@link module:font/fontfamily/fontfamilyui~FontFamilyUI} features in the editor.
- */
-export default class FontFamily extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [FontFamilyEditing, FontFamilyUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'FontFamily';
-    }
-}
+/**
+ * @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/fontfamily
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import FontFamilyEditing from './fontfamily/fontfamilyediting';
+import FontFamilyUI from './fontfamily/fontfamilyui';
+/**
+ * The font family plugin.
+ *
+ * For a detailed overview, check the {@glink features/font font feature} documentatiom
+ * and the {@glink api/font package page}.
+ *
+ * This is a "glue" plugin which loads the {@link module:font/fontfamily/fontfamilyediting~FontFamilyEditing} and
+ * {@link module:font/fontfamily/fontfamilyui~FontFamilyUI} features in the editor.
+ */
+export default class FontFamily extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [FontFamilyEditing, FontFamilyUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'FontFamily';
+    }
+}

package/src/fontsize/fontsizecommand.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 font/fontsize/fontsizecommand
- */
-import type { Editor } from 'ckeditor5/src/core';
-import FontCommand from '../fontcommand';
-/**
- * The font size command. It is used by {@link module:font/fontsize/fontsizeediting~FontSizeEditing}
- * to apply the font size.
- *
- * ```ts
- * editor.execute( 'fontSize', { value: 'small' } );
- * ```
- *
- * **Note**: Executing the command without the value removes the attribute from the model.
- */
-export default class FontSizeCommand extends FontCommand {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-}
+/**
+ * @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/fontsizecommand
+ */
+import type { Editor } from 'ckeditor5/src/core';
+import FontCommand from '../fontcommand';
+/**
+ * The font size command. It is used by {@link module:font/fontsize/fontsizeediting~FontSizeEditing}
+ * to apply the font size.
+ *
+ * ```ts
+ * editor.execute( 'fontSize', { value: 'small' } );
+ * ```
+ *
+ * **Note**: Executing the command without the value removes the attribute from the model.
+ */
+export default class FontSizeCommand extends FontCommand {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+}

package/src/fontsize/fontsizecommand.js

@@ -1,24 +1,24 @@
-/**
- * @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 FontCommand from '../fontcommand';
-import { FONT_SIZE } from '../utils';
-/**
- * The font size command. It is used by {@link module:font/fontsize/fontsizeediting~FontSizeEditing}
- * to apply the font size.
- *
- * ```ts
- * editor.execute( 'fontSize', { value: 'small' } );
- * ```
- *
- * **Note**: Executing the command without the value removes the attribute from the model.
- */
-export default class FontSizeCommand extends FontCommand {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor, FONT_SIZE);
-    }
-}
+/**
+ * @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 FontCommand from '../fontcommand';
+import { FONT_SIZE } from '../utils';
+/**
+ * The font size command. It is used by {@link module:font/fontsize/fontsizeediting~FontSizeEditing}
+ * to apply the font size.
+ *
+ * ```ts
+ * editor.execute( 'fontSize', { value: 'small' } );
+ * ```
+ *
+ * **Note**: Executing the command without the value removes the attribute from the model.
+ */
+export default class FontSizeCommand extends FontCommand {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor, FONT_SIZE);
+    }
+}