@ckeditor/ckeditor5-font 38.1.1 → 38.2.0-alpha.1

package/src/fontconfig.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/fontfamily/fontfamilycommand.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/fontfamily/fontfamilycommand
- */
-import type { Editor } from 'ckeditor5/src/core';
-import FontCommand from '../fontcommand';
-/**
- * The font family command. It is used by {@link module:font/fontfamily/fontfamilyediting~FontFamilyEditing}
- * to apply the font family.
- *
- * ```ts
- * editor.execute( 'fontFamily', { value: 'Arial' } );
- * ```
- *
- * **Note**: Executing the command without the value removes the attribute from the model.
- */
-export default class FontFamilyCommand 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/fontfamily/fontfamilycommand
+ */
+import type { Editor } from 'ckeditor5/src/core.js';
+import FontCommand from '../fontcommand.js';
+/**
+ * The font family command. It is used by {@link module:font/fontfamily/fontfamilyediting~FontFamilyEditing}
+ * to apply the font family.
+ *
+ * ```ts
+ * editor.execute( 'fontFamily', { value: 'Arial' } );
+ * ```
+ *
+ * **Note**: Executing the command without the value removes the attribute from the model.
+ */
+export default class FontFamilyCommand extends FontCommand {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+}

package/src/fontfamily/fontfamilycommand.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_FAMILY } from '../utils';
-/**
- * The font family command. It is used by {@link module:font/fontfamily/fontfamilyediting~FontFamilyEditing}
- * to apply the font family.
- *
- * ```ts
- * editor.execute( 'fontFamily', { value: 'Arial' } );
- * ```
- *
- * **Note**: Executing the command without the value removes the attribute from the model.
- */
-export default class FontFamilyCommand extends FontCommand {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor, FONT_FAMILY);
-    }
-}
+/**
+ * @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.js';
+import { FONT_FAMILY } from '../utils.js';
+/**
+ * The font family command. It is used by {@link module:font/fontfamily/fontfamilyediting~FontFamilyEditing}
+ * to apply the font family.
+ *
+ * ```ts
+ * editor.execute( 'fontFamily', { value: 'Arial' } );
+ * ```
+ *
+ * **Note**: Executing the command without the value removes the attribute from the model.
+ */
+export default class FontFamilyCommand extends FontCommand {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor, FONT_FAMILY);
+    }
+}

package/src/fontfamily/fontfamilyediting.d.ts

@@ -1,39 +1,39 @@
-/**
- * @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/fontfamilyediting
- */
-import { type Editor, Plugin } from 'ckeditor5/src/core';
-/**
- * The font family editing feature.
- *
- * It introduces the {@link module:font/fontfamily/fontfamilycommand~FontFamilyCommand command} and
- * the `fontFamily` attribute in the {@link module:engine/model/model~Model model} which renders
- * in the {@link module:engine/view/view view} as an inline `<span>` element (`<span style="font-family: Arial">`),
- * depending on the {@link module:font/fontconfig~FontFamilyConfig configuration}.
- */
-export default class FontFamilyEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FontFamilyEditing";
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * These converters enable keeping any value found as `style="font-family: *"` as a value of an attribute on a text even
-     * if it is not defined in the plugin configuration.
-     */
-    private _prepareAnyValueConverters;
-    /**
-     * Adds support for legacy `<font face="..">` 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/fontfamily/fontfamilyediting
+ */
+import { type Editor, Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The font family editing feature.
+ *
+ * It introduces the {@link module:font/fontfamily/fontfamilycommand~FontFamilyCommand command} and
+ * the `fontFamily` attribute in the {@link module:engine/model/model~Model model} which renders
+ * in the {@link module:engine/view/view view} as an inline `<span>` element (`<span style="font-family: Arial">`),
+ * depending on the {@link module:font/fontconfig~FontFamilyConfig configuration}.
+ */
+export default class FontFamilyEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "FontFamilyEditing";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * These converters enable keeping any value found as `style="font-family: *"` as a value of an attribute on a text even
+     * if it is not defined in the plugin configuration.
+     */
+    private _prepareAnyValueConverters;
+    /**
+     * Adds support for legacy `<font face="..">` formatting.
+     */
+    private _prepareCompatibilityConverter;
+}

package/src/fontfamily/fontfamilyediting.js

@@ -1,115 +1,115 @@
-/**
- * @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/fontfamilyediting
- */
-import { Plugin } from 'ckeditor5/src/core';
-import FontFamilyCommand from './fontfamilycommand';
-import { normalizeOptions } from './utils';
-import { buildDefinition, FONT_FAMILY } from '../utils';
-/**
- * The font family editing feature.
- *
- * It introduces the {@link module:font/fontfamily/fontfamilycommand~FontFamilyCommand command} and
- * the `fontFamily` attribute in the {@link module:engine/model/model~Model model} which renders
- * in the {@link module:engine/view/view view} as an inline `<span>` element (`<span style="font-family: Arial">`),
- * depending on the {@link module:font/fontconfig~FontFamilyConfig configuration}.
- */
-export default class FontFamilyEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'FontFamilyEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        // Define default configuration using font families shortcuts.
-        editor.config.define(FONT_FAMILY, {
-            options: [
-                'default',
-                'Arial, Helvetica, sans-serif',
-                'Courier New, Courier, monospace',
-                'Georgia, serif',
-                'Lucida Sans Unicode, Lucida Grande, sans-serif',
-                'Tahoma, Geneva, sans-serif',
-                'Times New Roman, Times, serif',
-                'Trebuchet MS, Helvetica, sans-serif',
-                'Verdana, Geneva, sans-serif'
-            ],
-            supportAllValues: false
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        // Allow fontFamily attribute on text nodes.
-        editor.model.schema.extend('$text', { allowAttributes: FONT_FAMILY });
-        editor.model.schema.setAttributeProperties(FONT_FAMILY, {
-            isFormatting: true,
-            copyOnEnter: true
-        });
-        // Get configured font family options without "default" option.
-        const options = normalizeOptions(editor.config.get('fontFamily.options')).filter(item => item.model);
-        const definition = buildDefinition(FONT_FAMILY, options);
-        // Set-up the two-way conversion.
-        if (editor.config.get('fontFamily.supportAllValues')) {
-            this._prepareAnyValueConverters();
-            this._prepareCompatibilityConverter();
-        }
-        else {
-            editor.conversion.attributeToElement(definition);
-        }
-        editor.commands.add(FONT_FAMILY, new FontFamilyCommand(editor));
-    }
-    /**
-     * These converters enable keeping any value found as `style="font-family: *"` as a value of an attribute on a text even
-     * if it is not defined in the plugin configuration.
-     */
-    _prepareAnyValueConverters() {
-        const editor = this.editor;
-        editor.conversion.for('downcast').attributeToElement({
-            model: FONT_FAMILY,
-            view: (attributeValue, { writer }) => {
-                return writer.createAttributeElement('span', { style: 'font-family:' + attributeValue }, { priority: 7 });
-            }
-        });
-        editor.conversion.for('upcast').elementToAttribute({
-            model: {
-                key: FONT_FAMILY,
-                value: (viewElement) => viewElement.getStyle('font-family')
-            },
-            view: {
-                name: 'span',
-                styles: {
-                    'font-family': /.*/
-                }
-            }
-        });
-    }
-    /**
-     * Adds support for legacy `<font face="..">` formatting.
-     */
-    _prepareCompatibilityConverter() {
-        const editor = this.editor;
-        editor.conversion.for('upcast').elementToAttribute({
-            view: {
-                name: 'font',
-                attributes: {
-                    'face': /.*/
-                }
-            },
-            model: {
-                key: FONT_FAMILY,
-                value: (viewElement) => viewElement.getAttribute('face')
-            }
-        });
-    }
-}
+/**
+ * @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/fontfamilyediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import FontFamilyCommand from './fontfamilycommand.js';
+import { normalizeOptions } from './utils.js';
+import { buildDefinition, FONT_FAMILY } from '../utils.js';
+/**
+ * The font family editing feature.
+ *
+ * It introduces the {@link module:font/fontfamily/fontfamilycommand~FontFamilyCommand command} and
+ * the `fontFamily` attribute in the {@link module:engine/model/model~Model model} which renders
+ * in the {@link module:engine/view/view view} as an inline `<span>` element (`<span style="font-family: Arial">`),
+ * depending on the {@link module:font/fontconfig~FontFamilyConfig configuration}.
+ */
+export default class FontFamilyEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'FontFamilyEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        // Define default configuration using font families shortcuts.
+        editor.config.define(FONT_FAMILY, {
+            options: [
+                'default',
+                'Arial, Helvetica, sans-serif',
+                'Courier New, Courier, monospace',
+                'Georgia, serif',
+                'Lucida Sans Unicode, Lucida Grande, sans-serif',
+                'Tahoma, Geneva, sans-serif',
+                'Times New Roman, Times, serif',
+                'Trebuchet MS, Helvetica, sans-serif',
+                'Verdana, Geneva, sans-serif'
+            ],
+            supportAllValues: false
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        // Allow fontFamily attribute on text nodes.
+        editor.model.schema.extend('$text', { allowAttributes: FONT_FAMILY });
+        editor.model.schema.setAttributeProperties(FONT_FAMILY, {
+            isFormatting: true,
+            copyOnEnter: true
+        });
+        // Get configured font family options without "default" option.
+        const options = normalizeOptions(editor.config.get('fontFamily.options')).filter(item => item.model);
+        const definition = buildDefinition(FONT_FAMILY, options);
+        // Set-up the two-way conversion.
+        if (editor.config.get('fontFamily.supportAllValues')) {
+            this._prepareAnyValueConverters();
+            this._prepareCompatibilityConverter();
+        }
+        else {
+            editor.conversion.attributeToElement(definition);
+        }
+        editor.commands.add(FONT_FAMILY, new FontFamilyCommand(editor));
+    }
+    /**
+     * These converters enable keeping any value found as `style="font-family: *"` as a value of an attribute on a text even
+     * if it is not defined in the plugin configuration.
+     */
+    _prepareAnyValueConverters() {
+        const editor = this.editor;
+        editor.conversion.for('downcast').attributeToElement({
+            model: FONT_FAMILY,
+            view: (attributeValue, { writer }) => {
+                return writer.createAttributeElement('span', { style: 'font-family:' + attributeValue }, { priority: 7 });
+            }
+        });
+        editor.conversion.for('upcast').elementToAttribute({
+            model: {
+                key: FONT_FAMILY,
+                value: (viewElement) => viewElement.getStyle('font-family')
+            },
+            view: {
+                name: 'span',
+                styles: {
+                    'font-family': /.*/
+                }
+            }
+        });
+    }
+    /**
+     * Adds support for legacy `<font face="..">` formatting.
+     */
+    _prepareCompatibilityConverter() {
+        const editor = this.editor;
+        editor.conversion.for('upcast').elementToAttribute({
+            view: {
+                name: 'font',
+                attributes: {
+                    'face': /.*/
+                }
+            },
+            model: {
+                key: FONT_FAMILY,
+                value: (viewElement) => viewElement.getAttribute('face')
+            }
+        });
+    }
+}

package/src/fontfamily/fontfamilyui.d.ts

@@ -1,30 +1,30 @@
-/**
- * @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';
-/**
- * The font family UI plugin. It introduces the `'fontFamily'` dropdown.
- */
-export default class FontFamilyUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FontFamilyUI";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * 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.
-     */
-    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/fontfamily/fontfamilyui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+/**
+ * The font family UI plugin. It introduces the `'fontFamily'` dropdown.
+ */
+export default class FontFamilyUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "FontFamilyUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * 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.
+     */
+    private _getLocalizedOptions;
+}