@ckeditor/ckeditor5-font 41.1.0 → 41.3.0-alpha.0

package/dist/types/augmentation.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import type { Font, FontBackgroundColor, FontBackgroundColorEditing, FontBackgroundColorUI, FontBackgroundColorCommand, FontColor, FontColorEditing, FontColorUI, FontColorCommand, FontColorConfig, FontFamily, FontFamilyEditing, FontFamilyUI, FontFamilyCommand, FontFamilyConfig, FontSize, FontSizeEditing, FontSizeUI, FontSizeCommand, FontSizeConfig, FONT_BACKGROUND_COLOR, FONT_COLOR, FONT_FAMILY, FONT_SIZE } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the font background color feature.
+         * It is introduced by the {@link module:font/fontbackgroundcolor/fontbackgroundcolorediting~FontBackgroundColorEditing} feature.
+         *
+         * Read more in {@link module:font/fontconfig~FontColorConfig}.
+         */
+        fontBackgroundColor?: FontColorConfig;
+        /**
+         * The configuration of the font color feature.
+         * It is introduced by the {@link module:font/fontcolor/fontcolorediting~FontColorEditing} feature.
+         *
+         * Read more in {@link module:font/fontconfig~FontColorConfig}.
+         */
+        fontColor?: FontColorConfig;
+        /**
+         * The configuration of the font family feature.
+         * It is introduced by the {@link module:font/fontfamily/fontfamilyediting~FontFamilyEditing} feature.
+         *
+         * Read more in {@link module:font/fontconfig~FontFamilyConfig}.
+         */
+        fontFamily?: FontFamilyConfig;
+        /**
+         * The configuration of the font size feature.
+         * It is introduced by the {@link module:font/fontsize/fontsizeediting~FontSizeEditing} feature.
+         *
+         * Read more in {@link module:font/fontconfig~FontSizeConfig}.
+         */
+        fontSize?: FontSizeConfig;
+    }
+    interface PluginsMap {
+        [Font.pluginName]: Font;
+        [FontBackgroundColor.pluginName]: FontBackgroundColor;
+        [FontBackgroundColorEditing.pluginName]: FontBackgroundColorEditing;
+        [FontBackgroundColorUI.pluginName]: FontBackgroundColorUI;
+        [FontColor.pluginName]: FontColor;
+        [FontColorEditing.pluginName]: FontColorEditing;
+        [FontColorUI.pluginName]: FontColorUI;
+        [FontFamily.pluginName]: FontFamily;
+        [FontFamilyEditing.pluginName]: FontFamilyEditing;
+        [FontFamilyUI.pluginName]: FontFamilyUI;
+        [FontSize.pluginName]: FontSize;
+        [FontSizeEditing.pluginName]: FontSizeEditing;
+        [FontSizeUI.pluginName]: FontSizeUI;
+    }
+    interface CommandsMap {
+        [FONT_SIZE]: FontSizeCommand;
+        [FONT_FAMILY]: FontFamilyCommand;
+        [FONT_COLOR]: FontColorCommand;
+        [FONT_BACKGROUND_COLOR]: FontBackgroundColorCommand;
+    }
+}

package/dist/types/font.d.ts

@@ -0,0 +1,33 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module font/font
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import FontFamily from './fontfamily.js';
+import FontSize from './fontsize.js';
+import FontColor from './fontcolor.js';
+import FontBackgroundColor from './fontbackgroundcolor.js';
+/**
+ * A plugin that enables a set of text styling features:
+ *
+ * * {@link module:font/fontsize~FontSize},
+ * * {@link module:font/fontfamily~FontFamily}.
+ * * {@link module:font/fontcolor~FontColor},
+ * * {@link module:font/fontbackgroundcolor~FontBackgroundColor}.
+ *
+ * For a detailed overview, check the {@glink features/font Font feature} documentation
+ * and the {@glink api/font package page}.
+ */
+export default class Font extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof FontFamily, typeof FontSize, typeof FontColor, typeof FontBackgroundColor];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Font";
+}

package/dist/types/fontbackgroundcolor/fontbackgroundcolorcommand.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license Copyright (c) 2003-2024, 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/fontbackgroundcolorcommand
+ */
+import type { Editor } from 'ckeditor5/src/core.js';
+import FontCommand from '../fontcommand.js';
+/**
+ * The font background color command. It is used by
+ * {@link module:font/fontbackgroundcolor/fontbackgroundcolorediting~FontBackgroundColorEditing}
+ * to apply the font background color.
+ *
+ * ```ts
+ * editor.execute( 'fontBackgroundColor', { value: 'rgb(250, 20, 20)' } );
+ * ```
+ *
+ * **Note**: Executing the command with the `null` value removes the attribute from the model.
+ */
+export default class FontBackgroundColorCommand extends FontCommand {
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+}

package/dist/types/fontbackgroundcolor/fontbackgroundcolorediting.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license Copyright (c) 2003-2024, 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, type Editor } from 'ckeditor5/src/core.js';
+/**
+ * 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(): "FontBackgroundColorEditing";
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+}

package/dist/types/fontbackgroundcolor/fontbackgroundcolorui.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+import type { Editor } from 'ckeditor5/src/core.js';
+/**
+ * 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/dist/types/fontbackgroundcolor.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+import FontBackgroundColorEditing from './fontbackgroundcolor/fontbackgroundcolorediting.js';
+import FontBackgroundColorUI from './fontbackgroundcolor/fontbackgroundcolorui.js';
+/**
+ * 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/dist/types/fontcolor/fontcolorcommand.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+import FontCommand from '../fontcommand.js';
+/**
+ * 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/dist/types/fontcolor/fontcolorediting.d.ts

@@ -0,0 +1,26 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+/**
+ * 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);
+}

package/dist/types/fontcolor/fontcolorui.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+import type { Editor } from 'ckeditor5/src/core.js';
+/**
+ * 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/dist/types/fontcolor.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+import FontColorEditing from './fontcolor/fontcolorediting.js';
+import FontColorUI from './fontcolor/fontcolorui.js';
+/**
+ * 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/dist/types/fontcommand.d.ts

@@ -0,0 +1,48 @@
+/**
+ * @license Copyright (c) 2003-2024, 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.js';
+import { type Batch } from 'ckeditor5/src/engine.js';
+/**
+ * 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;
+}