@ckeditor/ckeditor5-font 40.0.0 → 40.2.0

package/src/fontcolor/fontcolorediting.js

@@ -1,134 +1,134 @@
-/**
- * @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 } from 'ckeditor5/src/core';
-import FontColorCommand from './fontcolorcommand';
-import { FONT_COLOR, renderDowncastElement, renderUpcastAttribute } from '../utils';
-/**
- * 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() {
-        return 'FontColorEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    constructor(editor) {
-        super(editor);
-        editor.config.define(FONT_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.conversion.for('upcast').elementToAttribute({
-            view: {
-                name: 'span',
-                styles: {
-                    'color': /[\s\S]+/
-                }
-            },
-            model: {
-                key: FONT_COLOR,
-                value: renderUpcastAttribute('color')
-            }
-        });
-        // Support legacy `<font color="..">` formatting.
-        editor.conversion.for('upcast').elementToAttribute({
-            view: {
-                name: 'font',
-                attributes: {
-                    'color': /^#?\w+$/
-                }
-            },
-            model: {
-                key: FONT_COLOR,
-                value: (viewElement) => viewElement.getAttribute('color')
-            }
-        });
-        editor.conversion.for('downcast').attributeToElement({
-            model: FONT_COLOR,
-            view: renderDowncastElement('color')
-        });
-        editor.commands.add(FONT_COLOR, new FontColorCommand(editor));
-        // Allow the font color attribute on text nodes.
-        editor.model.schema.extend('$text', { allowAttributes: FONT_COLOR });
-        editor.model.schema.setAttributeProperties(FONT_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/fontcolor/fontcolorediting
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import FontColorCommand from './fontcolorcommand';
+import { FONT_COLOR, renderDowncastElement, renderUpcastAttribute } from '../utils';
+/**
+ * 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() {
+        return 'FontColorEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    constructor(editor) {
+        super(editor);
+        editor.config.define(FONT_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.conversion.for('upcast').elementToAttribute({
+            view: {
+                name: 'span',
+                styles: {
+                    'color': /[\s\S]+/
+                }
+            },
+            model: {
+                key: FONT_COLOR,
+                value: renderUpcastAttribute('color')
+            }
+        });
+        // Support legacy `<font color="..">` formatting.
+        editor.conversion.for('upcast').elementToAttribute({
+            view: {
+                name: 'font',
+                attributes: {
+                    'color': /^#?\w+$/
+                }
+            },
+            model: {
+                key: FONT_COLOR,
+                value: (viewElement) => viewElement.getAttribute('color')
+            }
+        });
+        editor.conversion.for('downcast').attributeToElement({
+            model: FONT_COLOR,
+            view: renderDowncastElement('color')
+        });
+        editor.commands.add(FONT_COLOR, new FontColorCommand(editor));
+        // Allow the font color attribute on text nodes.
+        editor.model.schema.extend('$text', { allowAttributes: FONT_COLOR });
+        editor.model.schema.setAttributeProperties(FONT_COLOR, {
+            isFormatting: true,
+            copyOnEnter: true
+        });
+    }
+}

package/src/fontcolor/fontcolorui.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/fontcolor/fontcolorui
- */
-import ColorUI from '../ui/colorui';
-import type { Editor } from 'ckeditor5/src/core';
-/**
- * The font color UI plugin. It introduces the `'fontColor'` dropdown.
- */
-export default class FontColorUI extends ColorUI {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FontColorUI";
-}
+/**
+ * @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/fontcolorui
+ */
+import ColorUI from '../ui/colorui';
+import type { Editor } from 'ckeditor5/src/core';
+/**
+ * The font color UI plugin. It introduces the `'fontColor'` dropdown.
+ */
+export default class FontColorUI extends ColorUI {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "FontColorUI";
+}

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

package/src/fontcolor.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/fontcolor
- */
-import { Plugin } from 'ckeditor5/src/core';
-import FontColorEditing from './fontcolor/fontcolorediting';
-import FontColorUI from './fontcolor/fontcolorui';
-/**
- * The font 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/fontcolor/fontcolorediting~FontColorEditing} and
- * {@link module:font/fontcolor/fontcolorui~FontColorUI} features in the editor.
- */
-export default class FontColor extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof FontColorEditing, typeof FontColorUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FontColor";
-}
+/**
+ * @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
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import FontColorEditing from './fontcolor/fontcolorediting';
+import FontColorUI from './fontcolor/fontcolorui';
+/**
+ * The font 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/fontcolor/fontcolorediting~FontColorEditing} and
+ * {@link module:font/fontcolor/fontcolorui~FontColorUI} features in the editor.
+ */
+export default class FontColor extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof FontColorEditing, typeof FontColorUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "FontColor";
+}

package/src/fontcolor.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/fontcolor
- */
-import { Plugin } from 'ckeditor5/src/core';
-import FontColorEditing from './fontcolor/fontcolorediting';
-import FontColorUI from './fontcolor/fontcolorui';
-/**
- * The font 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/fontcolor/fontcolorediting~FontColorEditing} and
- * {@link module:font/fontcolor/fontcolorui~FontColorUI} features in the editor.
- */
-export default class FontColor extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires() {
-        return [FontColorEditing, FontColorUI];
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'FontColor';
-    }
-}
+/**
+ * @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
+ */
+import { Plugin } from 'ckeditor5/src/core';
+import FontColorEditing from './fontcolor/fontcolorediting';
+import FontColorUI from './fontcolor/fontcolorui';
+/**
+ * The font 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/fontcolor/fontcolorediting~FontColorEditing} and
+ * {@link module:font/fontcolor/fontcolorui~FontColorUI} features in the editor.
+ */
+export default class FontColor extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires() {
+        return [FontColorEditing, FontColorUI];
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'FontColor';
+    }
+}

package/src/fontcommand.d.ts

@@ -1,48 +1,48 @@
-/**
- * @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/fontcommand
- */
-import { Command, type Editor } from 'ckeditor5/src/core';
-import { type Batch } from 'ckeditor5/src/engine';
-/**
- * The base font command.
- */
-export default abstract class FontCommand extends Command {
-    /**
-     * When set, it reflects the {@link #attributeKey} value of the selection.
-     *
-     * @observable
-     * @readonly
-     */
-    value: string;
-    /**
-     * A model attribute on which this command operates.
-     */
-    readonly attributeKey: string;
-    /**
-     * Creates an instance of the command.
-     *
-     * @param editor Editor instance.
-     * @param attributeKey The name of a model attribute on which this command operates.
-     */
-    constructor(editor: Editor, attributeKey: string);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command. Applies the `value` of the {@link #attributeKey} to the selection.
-     * If no `value` is passed, it removes the attribute from the selection.
-     *
-     * @param options Options for the executed command.
-     * @param options.value The value to apply.
-     * @fires execute
-     */
-    execute(options?: {
-        value?: string;
-        batch?: Batch;
-    }): void;
-}
+/**
+ * @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/fontcommand
+ */
+import { Command, type Editor } from 'ckeditor5/src/core';
+import { type Batch } from 'ckeditor5/src/engine';
+/**
+ * The base font command.
+ */
+export default abstract class FontCommand extends Command {
+    /**
+     * When set, it reflects the {@link #attributeKey} value of the selection.
+     *
+     * @observable
+     * @readonly
+     */
+    value: string;
+    /**
+     * A model attribute on which this command operates.
+     */
+    readonly attributeKey: string;
+    /**
+     * Creates an instance of the command.
+     *
+     * @param editor Editor instance.
+     * @param attributeKey The name of a model attribute on which this command operates.
+     */
+    constructor(editor: Editor, attributeKey: string);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command. Applies the `value` of the {@link #attributeKey} to the selection.
+     * If no `value` is passed, it removes the attribute from the selection.
+     *
+     * @param options Options for the executed command.
+     * @param options.value The value to apply.
+     * @fires execute
+     */
+    execute(options?: {
+        value?: string;
+        batch?: Batch;
+    }): void;
+}