@ckeditor/ckeditor5-font 40.0.0 → 40.2.0

package/src/fontsize/fontsizeediting.d.ts

@@ -1,44 +1,44 @@
-/**
- * @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/fontsizeediting
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-/**
- * The font size editing feature.
- *
- * It introduces the {@link module:font/fontsize/fontsizecommand~FontSizeCommand command} and the `fontSize`
- * attribute in the {@link module:engine/model/model~Model model} which renders in the {@link module:engine/view/view view}
- * as a `<span>` element with either:
- * * a style attribute (`<span style="font-size:12px">...</span>`),
- * * or a class attribute (`<span class="text-small">...</span>`)
- *
- * depending on the {@link module:font/fontconfig~FontSizeConfig configuration}.
- */
-export default class FontSizeEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FontSizeEditing";
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * These converters enable keeping any value found as `style="font-size: *"` as a value of an attribute on a text even
-     * if it is not defined in the plugin configuration.
-     *
-     * @param definition Converter definition out of input data.
-     */
-    private _prepareAnyValueConverters;
-    /**
-     * Adds support for legacy `<font size="..">` formatting.
-     */
-    private _prepareCompatibilityConverter;
-}
+/**
+ * @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/fontsizeediting
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+/**
+ * The font size editing feature.
+ *
+ * It introduces the {@link module:font/fontsize/fontsizecommand~FontSizeCommand command} and the `fontSize`
+ * attribute in the {@link module:engine/model/model~Model model} which renders in the {@link module:engine/view/view view}
+ * as a `<span>` element with either:
+ * * a style attribute (`<span style="font-size:12px">...</span>`),
+ * * or a class attribute (`<span class="text-small">...</span>`)
+ *
+ * depending on the {@link module:font/fontconfig~FontSizeConfig configuration}.
+ */
+export default class FontSizeEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "FontSizeEditing";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * These converters enable keeping any value found as `style="font-size: *"` as a value of an attribute on a text even
+     * if it is not defined in the plugin configuration.
+     *
+     * @param definition Converter definition out of input data.
+     */
+    private _prepareAnyValueConverters;
+    /**
+     * Adds support for legacy `<font size="..">` formatting.
+     */
+    private _prepareCompatibilityConverter;
+}

package/src/fontsize/fontsizeediting.js

@@ -1,165 +1,165 @@
-/**
- * @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/fontsizeediting
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { CKEditorError } from 'ckeditor5/src/utils';
-import { isLength, isPercentage } from 'ckeditor5/src/engine';
-import FontSizeCommand from './fontsizecommand';
-import { normalizeOptions } from './utils';
-import { buildDefinition, FONT_SIZE } from '../utils';
-// Mapping of `<font size="..">` styling to CSS's `font-size` values.
-const styleFontSize = [
-    'x-small',
-    'x-small',
-    'small',
-    'medium',
-    'large',
-    'x-large',
-    'xx-large',
-    'xxx-large'
-];
-/**
- * The font size editing feature.
- *
- * It introduces the {@link module:font/fontsize/fontsizecommand~FontSizeCommand command} and the `fontSize`
- * attribute in the {@link module:engine/model/model~Model model} which renders in the {@link module:engine/view/view view}
- * as a `<span>` element with either:
- * * a style attribute (`<span style="font-size:12px">...</span>`),
- * * or a class attribute (`<span class="text-small">...</span>`)
- *
- * depending on the {@link module:font/fontconfig~FontSizeConfig configuration}.
- */
-export default class FontSizeEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'FontSizeEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        // Define default configuration using named presets.
-        editor.config.define(FONT_SIZE, {
-            options: [
-                'tiny',
-                'small',
-                'default',
-                'big',
-                'huge'
-            ],
-            supportAllValues: false
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        // Allow fontSize attribute on text nodes.
-        editor.model.schema.extend('$text', { allowAttributes: FONT_SIZE });
-        editor.model.schema.setAttributeProperties(FONT_SIZE, {
-            isFormatting: true,
-            copyOnEnter: true
-        });
-        const supportAllValues = editor.config.get('fontSize.supportAllValues');
-        // Define view to model conversion.
-        const options = normalizeOptions(this.editor.config.get('fontSize.options'))
-            .filter(item => item.model);
-        const definition = buildDefinition(FONT_SIZE, options);
-        // Set-up the two-way conversion.
-        if (supportAllValues) {
-            this._prepareAnyValueConverters(definition);
-            this._prepareCompatibilityConverter();
-        }
-        else {
-            editor.conversion.attributeToElement(definition);
-        }
-        // Add FontSize command.
-        editor.commands.add(FONT_SIZE, new FontSizeCommand(editor));
-    }
-    /**
-     * These converters enable keeping any value found as `style="font-size: *"` as a value of an attribute on a text even
-     * if it is not defined in the plugin configuration.
-     *
-     * @param definition Converter definition out of input data.
-     */
-    _prepareAnyValueConverters(definition) {
-        const editor = this.editor;
-        // If `fontSize.supportAllValues=true`, we do not allow to use named presets in the plugin's configuration.
-        const presets = definition.model.values.filter((value) => {
-            return !isLength(String(value)) && !isPercentage(String(value));
-        });
-        if (presets.length) {
-            /**
-             * If {@link module:font/fontconfig~FontSizeConfig#supportAllValues `config.fontSize.supportAllValues`} is `true`,
-             * you need to use numerical values as font size options.
-             *
-             * See valid examples described in the {@link module:font/fontconfig~FontSizeConfig#options plugin configuration}.
-             *
-             * @error font-size-invalid-use-of-named-presets
-             * @param {Array.<String>} presets Invalid values.
-             */
-            throw new CKEditorError('font-size-invalid-use-of-named-presets', null, { presets });
-        }
-        editor.conversion.for('downcast').attributeToElement({
-            model: FONT_SIZE,
-            view: (attributeValue, { writer }) => {
-                if (!attributeValue) {
-                    return;
-                }
-                return writer.createAttributeElement('span', { style: 'font-size:' + attributeValue }, { priority: 7 });
-            }
-        });
-        editor.conversion.for('upcast').elementToAttribute({
-            model: {
-                key: FONT_SIZE,
-                value: (viewElement) => viewElement.getStyle('font-size')
-            },
-            view: {
-                name: 'span',
-                styles: {
-                    'font-size': /.*/
-                }
-            }
-        });
-    }
-    /**
-     * Adds support for legacy `<font size="..">` formatting.
-     */
-    _prepareCompatibilityConverter() {
-        const editor = this.editor;
-        editor.conversion.for('upcast').elementToAttribute({
-            view: {
-                name: 'font',
-                attributes: {
-                    // Documentation mentions sizes from 1 to 7. To handle old content we support all values
-                    // up to 999 but clamp it to the valid range. Why 999? It should cover accidental values
-                    // similar to percentage, e.g. 100%, 200% which could be the usual mistake for font size.
-                    'size': /^[+-]?\d{1,3}$/
-                }
-            },
-            model: {
-                key: FONT_SIZE,
-                value: (viewElement) => {
-                    const value = viewElement.getAttribute('size');
-                    const isRelative = value[0] === '-' || value[0] === '+';
-                    let size = parseInt(value, 10);
-                    if (isRelative) {
-                        // Add relative size (which can be negative) to the default size = 3.
-                        size = 3 + size;
-                    }
-                    const maxSize = styleFontSize.length - 1;
-                    const clampedSize = Math.min(Math.max(size, 0), maxSize);
-                    return styleFontSize[clampedSize];
-                }
-            }
-        });
-    }
-}
+/**
+ * @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/fontsizeediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { CKEditorError } from 'ckeditor5/src/utils';
+import { isLength, isPercentage } from 'ckeditor5/src/engine';
+import FontSizeCommand from './fontsizecommand';
+import { normalizeOptions } from './utils';
+import { buildDefinition, FONT_SIZE } from '../utils';
+// Mapping of `<font size="..">` styling to CSS's `font-size` values.
+const styleFontSize = [
+    'x-small',
+    'x-small',
+    'small',
+    'medium',
+    'large',
+    'x-large',
+    'xx-large',
+    'xxx-large'
+];
+/**
+ * The font size editing feature.
+ *
+ * It introduces the {@link module:font/fontsize/fontsizecommand~FontSizeCommand command} and the `fontSize`
+ * attribute in the {@link module:engine/model/model~Model model} which renders in the {@link module:engine/view/view view}
+ * as a `<span>` element with either:
+ * * a style attribute (`<span style="font-size:12px">...</span>`),
+ * * or a class attribute (`<span class="text-small">...</span>`)
+ *
+ * depending on the {@link module:font/fontconfig~FontSizeConfig configuration}.
+ */
+export default class FontSizeEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'FontSizeEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        // Define default configuration using named presets.
+        editor.config.define(FONT_SIZE, {
+            options: [
+                'tiny',
+                'small',
+                'default',
+                'big',
+                'huge'
+            ],
+            supportAllValues: false
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        // Allow fontSize attribute on text nodes.
+        editor.model.schema.extend('$text', { allowAttributes: FONT_SIZE });
+        editor.model.schema.setAttributeProperties(FONT_SIZE, {
+            isFormatting: true,
+            copyOnEnter: true
+        });
+        const supportAllValues = editor.config.get('fontSize.supportAllValues');
+        // Define view to model conversion.
+        const options = normalizeOptions(this.editor.config.get('fontSize.options'))
+            .filter(item => item.model);
+        const definition = buildDefinition(FONT_SIZE, options);
+        // Set-up the two-way conversion.
+        if (supportAllValues) {
+            this._prepareAnyValueConverters(definition);
+            this._prepareCompatibilityConverter();
+        }
+        else {
+            editor.conversion.attributeToElement(definition);
+        }
+        // Add FontSize command.
+        editor.commands.add(FONT_SIZE, new FontSizeCommand(editor));
+    }
+    /**
+     * These converters enable keeping any value found as `style="font-size: *"` as a value of an attribute on a text even
+     * if it is not defined in the plugin configuration.
+     *
+     * @param definition Converter definition out of input data.
+     */
+    _prepareAnyValueConverters(definition) {
+        const editor = this.editor;
+        // If `fontSize.supportAllValues=true`, we do not allow to use named presets in the plugin's configuration.
+        const presets = definition.model.values.filter((value) => {
+            return !isLength(String(value)) && !isPercentage(String(value));
+        });
+        if (presets.length) {
+            /**
+             * If {@link module:font/fontconfig~FontSizeConfig#supportAllValues `config.fontSize.supportAllValues`} is `true`,
+             * you need to use numerical values as font size options.
+             *
+             * See valid examples described in the {@link module:font/fontconfig~FontSizeConfig#options plugin configuration}.
+             *
+             * @error font-size-invalid-use-of-named-presets
+             * @param {Array.<String>} presets Invalid values.
+             */
+            throw new CKEditorError('font-size-invalid-use-of-named-presets', null, { presets });
+        }
+        editor.conversion.for('downcast').attributeToElement({
+            model: FONT_SIZE,
+            view: (attributeValue, { writer }) => {
+                if (!attributeValue) {
+                    return;
+                }
+                return writer.createAttributeElement('span', { style: 'font-size:' + attributeValue }, { priority: 7 });
+            }
+        });
+        editor.conversion.for('upcast').elementToAttribute({
+            model: {
+                key: FONT_SIZE,
+                value: (viewElement) => viewElement.getStyle('font-size')
+            },
+            view: {
+                name: 'span',
+                styles: {
+                    'font-size': /.*/
+                }
+            }
+        });
+    }
+    /**
+     * Adds support for legacy `<font size="..">` formatting.
+     */
+    _prepareCompatibilityConverter() {
+        const editor = this.editor;
+        editor.conversion.for('upcast').elementToAttribute({
+            view: {
+                name: 'font',
+                attributes: {
+                    // Documentation mentions sizes from 1 to 7. To handle old content we support all values
+                    // up to 999 but clamp it to the valid range. Why 999? It should cover accidental values
+                    // similar to percentage, e.g. 100%, 200% which could be the usual mistake for font size.
+                    'size': /^[+-]?\d{1,3}$/
+                }
+            },
+            model: {
+                key: FONT_SIZE,
+                value: (viewElement) => {
+                    const value = viewElement.getAttribute('size');
+                    const isRelative = value[0] === '-' || value[0] === '+';
+                    let size = parseInt(value, 10);
+                    if (isRelative) {
+                        // Add relative size (which can be negative) to the default size = 3.
+                        size = 3 + size;
+                    }
+                    const maxSize = styleFontSize.length - 1;
+                    const clampedSize = Math.min(Math.max(size, 0), maxSize);
+                    return styleFontSize[clampedSize];
+                }
+            }
+        });
+    }
+}

package/src/fontsize/fontsizeui.d.ts

@@ -1,31 +1,31 @@
-/**
- * @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 '../../theme/fontsize.css';
-/**
- * The font size UI plugin. It introduces the `'fontSize'` dropdown.
- */
-export default class FontSizeUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FontSizeUI";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * 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.
-     */
-    private _getLocalizedOptions;
-}
+/**
+ * @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 '../../theme/fontsize.css';
+/**
+ * The font size UI plugin. It introduces the `'fontSize'` dropdown.
+ */
+export default class FontSizeUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "FontSizeUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * 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.
+     */
+    private _getLocalizedOptions;
+}