@ckeditor/ckeditor5-font 40.0.0 → 40.2.0

package/src/fontbackgroundcolor/fontbackgroundcolorediting.js

@@ -1,123 +1,123 @@
-/**
- * @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/fontbackgroundcolor/fontbackgroundcolorediting
- */
-import { Plugin } from 'ckeditor5/src/core';
-import { addBackgroundRules } from 'ckeditor5/src/engine';
-import FontBackgroundColorCommand from './fontbackgroundcolorcommand';
-import { FONT_BACKGROUND_COLOR, renderDowncastElement, renderUpcastAttribute } from '../utils';
-/**
- * The font background color editing feature.
- *
- * It introduces the {@link module:font/fontbackgroundcolor/fontbackgroundcolorcommand~FontBackgroundColorCommand command} and
- * the `fontBackgroundColor` attribute in the {@link module:engine/model/model~Model model} which renders
- * in the {@link module:engine/view/view view} as a `<span>` element (`<span style="background-color: ...">`),
- * depending on the {@link module:font/fontconfig~FontColorConfig configuration}.
- */
-export default class FontBackgroundColorEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'FontBackgroundColorEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        editor.config.define(FONT_BACKGROUND_COLOR, {
-            colors: [
-                {
-                    color: 'hsl(0, 0%, 0%)',
-                    label: 'Black'
-                },
-                {
-                    color: 'hsl(0, 0%, 30%)',
-                    label: 'Dim grey'
-                },
-                {
-                    color: 'hsl(0, 0%, 60%)',
-                    label: 'Grey'
-                },
-                {
-                    color: 'hsl(0, 0%, 90%)',
-                    label: 'Light grey'
-                },
-                {
-                    color: 'hsl(0, 0%, 100%)',
-                    label: 'White',
-                    hasBorder: true
-                },
-                {
-                    color: 'hsl(0, 75%, 60%)',
-                    label: 'Red'
-                },
-                {
-                    color: 'hsl(30, 75%, 60%)',
-                    label: 'Orange'
-                },
-                {
-                    color: 'hsl(60, 75%, 60%)',
-                    label: 'Yellow'
-                },
-                {
-                    color: 'hsl(90, 75%, 60%)',
-                    label: 'Light green'
-                },
-                {
-                    color: 'hsl(120, 75%, 60%)',
-                    label: 'Green'
-                },
-                {
-                    color: 'hsl(150, 75%, 60%)',
-                    label: 'Aquamarine'
-                },
-                {
-                    color: 'hsl(180, 75%, 60%)',
-                    label: 'Turquoise'
-                },
-                {
-                    color: 'hsl(210, 75%, 60%)',
-                    label: 'Light blue'
-                },
-                {
-                    color: 'hsl(240, 75%, 60%)',
-                    label: 'Blue'
-                },
-                {
-                    color: 'hsl(270, 75%, 60%)',
-                    label: 'Purple'
-                }
-            ],
-            columns: 5
-        });
-        editor.data.addStyleProcessorRules(addBackgroundRules);
-        editor.conversion.for('upcast').elementToAttribute({
-            view: {
-                name: 'span',
-                styles: {
-                    'background-color': /[\s\S]+/
-                }
-            },
-            model: {
-                key: FONT_BACKGROUND_COLOR,
-                value: renderUpcastAttribute('background-color')
-            }
-        });
-        editor.conversion.for('downcast').attributeToElement({
-            model: FONT_BACKGROUND_COLOR,
-            view: renderDowncastElement('background-color')
-        });
-        editor.commands.add(FONT_BACKGROUND_COLOR, new FontBackgroundColorCommand(editor));
-        // Allow the font backgroundColor attribute on text nodes.
-        editor.model.schema.extend('$text', { allowAttributes: FONT_BACKGROUND_COLOR });
-        editor.model.schema.setAttributeProperties(FONT_BACKGROUND_COLOR, {
-            isFormatting: true,
-            copyOnEnter: true
-        });
-    }
-}
+/**
+ * @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/fontbackgroundcolor/fontbackgroundcolorediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import { addBackgroundRules } from 'ckeditor5/src/engine';
+import FontBackgroundColorCommand from './fontbackgroundcolorcommand';
+import { FONT_BACKGROUND_COLOR, renderDowncastElement, renderUpcastAttribute } from '../utils';
+/**
+ * The font background color editing feature.
+ *
+ * It introduces the {@link module:font/fontbackgroundcolor/fontbackgroundcolorcommand~FontBackgroundColorCommand command} and
+ * the `fontBackgroundColor` attribute in the {@link module:engine/model/model~Model model} which renders
+ * in the {@link module:engine/view/view view} as a `<span>` element (`<span style="background-color: ...">`),
+ * depending on the {@link module:font/fontconfig~FontColorConfig configuration}.
+ */
+export default class FontBackgroundColorEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'FontBackgroundColorEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        editor.config.define(FONT_BACKGROUND_COLOR, {
+            colors: [
+                {
+                    color: 'hsl(0, 0%, 0%)',
+                    label: 'Black'
+                },
+                {
+                    color: 'hsl(0, 0%, 30%)',
+                    label: 'Dim grey'
+                },
+                {
+                    color: 'hsl(0, 0%, 60%)',
+                    label: 'Grey'
+                },
+                {
+                    color: 'hsl(0, 0%, 90%)',
+                    label: 'Light grey'
+                },
+                {
+                    color: 'hsl(0, 0%, 100%)',
+                    label: 'White',
+                    hasBorder: true
+                },
+                {
+                    color: 'hsl(0, 75%, 60%)',
+                    label: 'Red'
+                },
+                {
+                    color: 'hsl(30, 75%, 60%)',
+                    label: 'Orange'
+                },
+                {
+                    color: 'hsl(60, 75%, 60%)',
+                    label: 'Yellow'
+                },
+                {
+                    color: 'hsl(90, 75%, 60%)',
+                    label: 'Light green'
+                },
+                {
+                    color: 'hsl(120, 75%, 60%)',
+                    label: 'Green'
+                },
+                {
+                    color: 'hsl(150, 75%, 60%)',
+                    label: 'Aquamarine'
+                },
+                {
+                    color: 'hsl(180, 75%, 60%)',
+                    label: 'Turquoise'
+                },
+                {
+                    color: 'hsl(210, 75%, 60%)',
+                    label: 'Light blue'
+                },
+                {
+                    color: 'hsl(240, 75%, 60%)',
+                    label: 'Blue'
+                },
+                {
+                    color: 'hsl(270, 75%, 60%)',
+                    label: 'Purple'
+                }
+            ],
+            columns: 5
+        });
+        editor.data.addStyleProcessorRules(addBackgroundRules);
+        editor.conversion.for('upcast').elementToAttribute({
+            view: {
+                name: 'span',
+                styles: {
+                    'background-color': /[\s\S]+/
+                }
+            },
+            model: {
+                key: FONT_BACKGROUND_COLOR,
+                value: renderUpcastAttribute('background-color')
+            }
+        });
+        editor.conversion.for('downcast').attributeToElement({
+            model: FONT_BACKGROUND_COLOR,
+            view: renderDowncastElement('background-color')
+        });
+        editor.commands.add(FONT_BACKGROUND_COLOR, new FontBackgroundColorCommand(editor));
+        // Allow the font backgroundColor attribute on text nodes.
+        editor.model.schema.extend('$text', { allowAttributes: FONT_BACKGROUND_COLOR });
+        editor.model.schema.setAttributeProperties(FONT_BACKGROUND_COLOR, {
+            isFormatting: true,
+            copyOnEnter: true
+        });
+    }
+}

package/src/fontbackgroundcolor/fontbackgroundcolorui.d.ts

@@ -1,22 +1,22 @@
-/**
- * @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/fontbackgroundcolor/fontbackgroundcolorui
- */
-import ColorUI from '../ui/colorui';
-import type { Editor } from 'ckeditor5/src/core';
-/**
- * The font background color UI plugin. It introduces the `'fontBackgroundColor'` dropdown.
- */
-export default class FontBackgroundColorUI extends ColorUI {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FontBackgroundColorUI";
-}
+/**
+ * @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/fontbackgroundcolor/fontbackgroundcolorui
+ */
+import ColorUI from '../ui/colorui';
+import type { Editor } from 'ckeditor5/src/core';
+/**
+ * The font background color UI plugin. It introduces the `'fontBackgroundColor'` dropdown.
+ */
+export default class FontBackgroundColorUI extends ColorUI {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "FontBackgroundColorUI";
+}

package/src/fontbackgroundcolor/fontbackgroundcolorui.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/fontbackgroundcolor/fontbackgroundcolorui
- */
-import ColorUI from '../ui/colorui';
-import { FONT_BACKGROUND_COLOR } from '../utils';
-import fontBackgroundColorIcon from '../../theme/icons/font-background.svg';
-/**
- * The font background color UI plugin. It introduces the `'fontBackgroundColor'` dropdown.
- */
-export default class FontBackgroundColorUI extends ColorUI {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        const t = editor.locale.t;
-        super(editor, {
-            commandName: FONT_BACKGROUND_COLOR,
-            componentName: FONT_BACKGROUND_COLOR,
-            icon: fontBackgroundColorIcon,
-            dropdownLabel: t('Font Background Color')
-        });
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'FontBackgroundColorUI';
-    }
-}
+/**
+ * @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/fontbackgroundcolor/fontbackgroundcolorui
+ */
+import ColorUI from '../ui/colorui';
+import { FONT_BACKGROUND_COLOR } from '../utils';
+import fontBackgroundColorIcon from '../../theme/icons/font-background.svg';
+/**
+ * The font background color UI plugin. It introduces the `'fontBackgroundColor'` dropdown.
+ */
+export default class FontBackgroundColorUI extends ColorUI {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        const t = editor.locale.t;
+        super(editor, {
+            commandName: FONT_BACKGROUND_COLOR,
+            componentName: FONT_BACKGROUND_COLOR,
+            icon: fontBackgroundColorIcon,
+            dropdownLabel: t('Font Background Color')
+        });
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'FontBackgroundColorUI';
+    }
+}

package/src/fontbackgroundcolor.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/fontbackgroundcolor
- */
-import { Plugin } from 'ckeditor5/src/core';
-import FontBackgroundColorEditing from './fontbackgroundcolor/fontbackgroundcolorediting';
-import FontBackgroundColorUI from './fontbackgroundcolor/fontbackgroundcolorui';
-/**
- * The font background color plugin.
- *
- * For a detailed overview, check the {@glink features/font font feature} documentation
- * and the {@glink api/font package page}.
- *
- * This is a "glue" plugin which loads
- * the {@link module:font/fontbackgroundcolor/fontbackgroundcolorediting~FontBackgroundColorEditing} and
- * {@link module:font/fontbackgroundcolor/fontbackgroundcolorui~FontBackgroundColorUI} features in the editor.
- */
-export default class FontBackgroundColor extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof FontBackgroundColorEditing, typeof FontBackgroundColorUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FontBackgroundColor";
-}
+/**
+ * @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/fontbackgroundcolor
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import FontBackgroundColorEditing from './fontbackgroundcolor/fontbackgroundcolorediting';
+import FontBackgroundColorUI from './fontbackgroundcolor/fontbackgroundcolorui';
+/**
+ * The font background color plugin.
+ *
+ * For a detailed overview, check the {@glink features/font font feature} documentation
+ * and the {@glink api/font package page}.
+ *
+ * This is a "glue" plugin which loads
+ * the {@link module:font/fontbackgroundcolor/fontbackgroundcolorediting~FontBackgroundColorEditing} and
+ * {@link module:font/fontbackgroundcolor/fontbackgroundcolorui~FontBackgroundColorUI} features in the editor.
+ */
+export default class FontBackgroundColor extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof FontBackgroundColorEditing, typeof FontBackgroundColorUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "FontBackgroundColor";
+}

package/src/fontbackgroundcolor.js

@@ -1,34 +1,34 @@
-/**
- * @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/fontbackgroundcolor
- */
-import { Plugin } from 'ckeditor5/src/core';
-import FontBackgroundColorEditing from './fontbackgroundcolor/fontbackgroundcolorediting';
-import FontBackgroundColorUI from './fontbackgroundcolor/fontbackgroundcolorui';
-/**
- * The font background color plugin.
- *
- * For a detailed overview, check the {@glink features/font font feature} documentation
- * and the {@glink api/font package page}.
- *
- * This is a "glue" plugin which loads
- * the {@link module:font/fontbackgroundcolor/fontbackgroundcolorediting~FontBackgroundColorEditing} and
- * {@link module:font/fontbackgroundcolor/fontbackgroundcolorui~FontBackgroundColorUI} features in the editor.
- */
-export default class FontBackgroundColor extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [FontBackgroundColorEditing, FontBackgroundColorUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'FontBackgroundColor';
-    }
-}
+/**
+ * @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/fontbackgroundcolor
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import FontBackgroundColorEditing from './fontbackgroundcolor/fontbackgroundcolorediting';
+import FontBackgroundColorUI from './fontbackgroundcolor/fontbackgroundcolorui';
+/**
+ * The font background color plugin.
+ *
+ * For a detailed overview, check the {@glink features/font font feature} documentation
+ * and the {@glink api/font package page}.
+ *
+ * This is a "glue" plugin which loads
+ * the {@link module:font/fontbackgroundcolor/fontbackgroundcolorediting~FontBackgroundColorEditing} and
+ * {@link module:font/fontbackgroundcolor/fontbackgroundcolorui~FontBackgroundColorUI} features in the editor.
+ */
+export default class FontBackgroundColor extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [FontBackgroundColorEditing, FontBackgroundColorUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'FontBackgroundColor';
+    }
+}

package/src/fontcolor/fontcolorcommand.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/fontcolor/fontcolorcommand
- */
-import type { Editor } from 'ckeditor5/src/core';
-import FontCommand from '../fontcommand';
-/**
- * The font color command. It is used by {@link module:font/fontcolor/fontcolorediting~FontColorEditing}
- * to apply the font color.
- *
- * ```ts
- * editor.execute( 'fontColor', { value: 'rgb(250, 20, 20)' } );
- * ```
- *
- * **Note**: Executing the command with the `null` value removes the attribute from the model.
- */
-export default class FontColorCommand 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/fontcolor/fontcolorcommand
+ */
+import type { Editor } from 'ckeditor5/src/core';
+import FontCommand from '../fontcommand';
+/**
+ * The font color command. It is used by {@link module:font/fontcolor/fontcolorediting~FontColorEditing}
+ * to apply the font color.
+ *
+ * ```ts
+ * editor.execute( 'fontColor', { value: 'rgb(250, 20, 20)' } );
+ * ```
+ *
+ * **Note**: Executing the command with the `null` value removes the attribute from the model.
+ */
+export default class FontColorCommand extends FontCommand {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+}

package/src/fontcolor/fontcolorcommand.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_COLOR } from '../utils';
-/**
- * The font color command. It is used by {@link module:font/fontcolor/fontcolorediting~FontColorEditing}
- * to apply the font color.
- *
- * ```ts
- * editor.execute( 'fontColor', { value: 'rgb(250, 20, 20)' } );
- * ```
- *
- * **Note**: Executing the command with the `null` value removes the attribute from the model.
- */
-export default class FontColorCommand extends FontCommand {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor, FONT_COLOR);
-    }
-}
+/**
+ * @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_COLOR } from '../utils';
+/**
+ * The font color command. It is used by {@link module:font/fontcolor/fontcolorediting~FontColorEditing}
+ * to apply the font color.
+ *
+ * ```ts
+ * editor.execute( 'fontColor', { value: 'rgb(250, 20, 20)' } );
+ * ```
+ *
+ * **Note**: Executing the command with the `null` value removes the attribute from the model.
+ */
+export default class FontColorCommand extends FontCommand {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor, FONT_COLOR);
+    }
+}

package/src/fontcolor/fontcolorediting.d.ts

@@ -1,26 +1,26 @@
-/**
- * @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/fontcolor/fontcolorediting
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core';
-/**
- * The font color editing feature.
- *
- * It introduces the {@link module:font/fontcolor/fontcolorcommand~FontColorCommand command} and
- * the `fontColor` attribute in the {@link module:engine/model/model~Model model} which renders
- * in the {@link module:engine/view/view view} as a `<span>` element (`<span style="color: ...">`),
- * depending on the {@link module:font/fontconfig~FontColorConfig configuration}.
- */
-export default class FontColorEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FontColorEditing";
-    /**
-     * @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/fontcolor/fontcolorediting
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+/**
+ * The font color editing feature.
+ *
+ * It introduces the {@link module:font/fontcolor/fontcolorcommand~FontColorCommand command} and
+ * the `fontColor` attribute in the {@link module:engine/model/model~Model model} which renders
+ * in the {@link module:engine/view/view view} as a `<span>` element (`<span style="color: ...">`),
+ * depending on the {@link module:font/fontconfig~FontColorConfig configuration}.
+ */
+export default class FontColorEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "FontColorEditing";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+}