@ckeditor/ckeditor5-font 44.1.0 → 44.2.0-alpha.0

package/dist/fontsize.d.ts

@@ -1,45 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module font/fontsize
- */
-import { Plugin } from 'ckeditor5/src/core.js';
-import FontSizeEditing from './fontsize/fontsizeediting.js';
-import FontSizeUI from './fontsize/fontsizeui.js';
-import type { FontSizeOption } from './fontconfig.js';
-/**
- * The font size 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/fontsize/fontsizeediting~FontSizeEditing} and
- * {@link module:font/fontsize/fontsizeui~FontSizeUI} features in the editor.
- */
-export default class FontSize extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof FontSizeEditing, typeof FontSizeUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "FontSize";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * Normalizes and translates the {@link module:font/fontconfig~FontSizeConfig#options configuration options}
-     * to the {@link module:font/fontconfig~FontSizeOption} format.
-     *
-     * @param configuredOptions An array of options taken from the configuration.
-     */
-    normalizeSizeOptions(options: Array<string | number | FontSizeOption>): Array<FontSizeOption>;
-}

package/dist/index.d.ts

@@ -1,31 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module font
- */
-export { default as Font } from './font.js';
-export { default as FontBackgroundColor } from './fontbackgroundcolor.js';
-export { default as FontColor } from './fontcolor.js';
-export { default as FontFamily } from './fontfamily.js';
-export { default as FontSize } from './fontsize.js';
-export { default as FontBackgroundColorEditing } from './fontbackgroundcolor/fontbackgroundcolorediting.js';
-export { default as FontBackgroundColorUI } from './fontbackgroundcolor/fontbackgroundcolorui.js';
-export { default as FontColorEditing } from './fontcolor/fontcolorediting.js';
-export { default as FontColorUI } from './fontcolor/fontcolorui.js';
-export { default as FontFamilyEditing } from './fontfamily/fontfamilyediting.js';
-export { default as FontFamilyUI } from './fontfamily/fontfamilyui.js';
-export { default as FontSizeEditing } from './fontsize/fontsizeediting.js';
-export { default as FontSizeUI } from './fontsize/fontsizeui.js';
-export type { default as FontBackgroundColorCommand } from './fontbackgroundcolor/fontbackgroundcolorcommand.js';
-export type { default as FontColorCommand } from './fontcolor/fontcolorcommand.js';
-export type { default as FontFamilyCommand } from './fontfamily/fontfamilycommand.js';
-export type { default as FontSizeCommand } from './fontsize/fontsizecommand.js';
-export type { FONT_BACKGROUND_COLOR, FONT_COLOR, FONT_FAMILY, FONT_SIZE } from './utils.js';
-export type { FontColorConfig, FontFamilyConfig, FontSizeConfig } from './fontconfig.js';
-import './augmentation.js';

package/dist/ui/colorui.d.ts

@@ -1,67 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module font/ui/colorui
- */
-import { Plugin, type Editor } from 'ckeditor5/src/core.js';
-import { type FONT_BACKGROUND_COLOR, type FONT_COLOR } from '../utils.js';
-/**
- * The color UI plugin which isolates the common logic responsible for displaying dropdowns with color grids.
- *
- * It is used to create the `'fontBackgroundColor'` and `'fontColor'` dropdowns, each hosting
- * a {@link module:ui/colorselector/colorselectorview~ColorSelectorView}.
- */
-export default class ColorUI extends Plugin {
-    /**
-     * The name of the command which will be executed when a color tile is clicked.
-     */
-    commandName: typeof FONT_BACKGROUND_COLOR | typeof FONT_COLOR;
-    /**
-     * The name of this component in the {@link module:ui/componentfactory~ComponentFactory}.
-     * Also the configuration scope name in `editor.config`.
-     */
-    componentName: typeof FONT_BACKGROUND_COLOR | typeof FONT_COLOR;
-    /**
-     * The SVG icon used by the dropdown.
-     */
-    icon: string;
-    /**
-     * The label used by the dropdown.
-     */
-    dropdownLabel: string;
-    /**
-     * The number of columns in the color grid.
-     */
-    columns: number;
-    /**
-     * Keeps all changes in color picker in one batch while dropdown is open.
-     */
-    private _undoStepBatch;
-    /**
-     * Creates a plugin which introduces a dropdown with a pre–configured
-     * {@link module:ui/colorselector/colorselectorview~ColorSelectorView}.
-     *
-     * @param config The configuration object.
-     * @param config.commandName The name of the command which will be executed when a color tile is clicked.
-     * @param config.componentName The name of the dropdown in the {@link module:ui/componentfactory~ComponentFactory}
-     * and the configuration scope name in `editor.config`.
-     * @param config.icon The SVG icon used by the dropdown.
-     * @param config.dropdownLabel The label used by the dropdown.
-     */
-    constructor(editor: Editor, { commandName, componentName, icon, dropdownLabel }: {
-        commandName: typeof FONT_BACKGROUND_COLOR | typeof FONT_COLOR;
-        componentName: typeof FONT_BACKGROUND_COLOR | typeof FONT_COLOR;
-        icon: string;
-        dropdownLabel: string;
-    });
-    /**
-    * @inheritDoc
-    */
-    init(): void;
-}

package/dist/utils.d.ts

@@ -1,84 +0,0 @@
-/**
- * @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
- */
-/**
- * @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-licensing-options
- */
-/**
- * @module font/utils
- */
-import type { FontFamilyOption, FontSizeOption } from './fontconfig.js';
-import { ColorSelectorView, type ColorDefinition, type ColorPickerViewConfig, type DropdownView } from 'ckeditor5/src/ui.js';
-import type { ArrayOrItem } from 'ckeditor5/src/utils.js';
-import type { ViewAttributeElement, ViewElement, MatcherPattern, ViewElementDefinition, DowncastConversionApi } from 'ckeditor5/src/engine.js';
-/**
- * The name of the font size plugin.
- */
-export declare const FONT_SIZE = "fontSize";
-/**
- * The name of the font family plugin.
- */
-export declare const FONT_FAMILY = "fontFamily";
-/**
- * The name of the font color plugin.
- */
-export declare const FONT_COLOR = "fontColor";
-/**
- * The name of the font background color plugin.
- */
-export declare const FONT_BACKGROUND_COLOR = "fontBackgroundColor";
-/**
- * Builds a proper converter definition out of input data.
- */
-export declare function buildDefinition(modelAttributeKey: string, options: Array<FontFamilyOption> | Array<FontSizeOption>): FontConverterDefinition;
-export type FontConverterDefinition = {
-    model: {
-        key: string;
-        values: Array<string>;
-    };
-    view: Record<string, ViewElementDefinition>;
-    upcastAlso: Record<string, ArrayOrItem<MatcherPattern>>;
-};
-/**
- * A {@link module:font/fontcolor~FontColor font color} and
- * {@link module:font/fontbackgroundcolor~FontBackgroundColor font background color} helper
- * responsible for upcasting data to the model.
- *
- * **Note**: The `styleAttr` parameter should be either `'color'` or `'background-color'`.
- */
-export declare function renderUpcastAttribute(styleAttr: string): (viewElement: ViewElement) => string;
-/**
- * A {@link module:font/fontcolor~FontColor font color} and
- * {@link module:font/fontbackgroundcolor~FontBackgroundColor font background color} helper
- * responsible for downcasting a color attribute to a `<span>` element.
- *
- * **Note**: The `styleAttr` parameter should be either `'color'` or `'background-color'`.
- */
-export declare function renderDowncastElement(styleAttr: string): (modelAttributeValue: string, { writer }: DowncastConversionApi) => ViewAttributeElement;
-/**
- * A helper that adds {@link module:ui/colorselector/colorselectorview~ColorSelectorView} to the color dropdown with proper initial values.
- *
- * @param config.dropdownView The dropdown view to which a {@link module:ui/colorselector/colorselectorview~ColorSelectorView}
- * will be added.
- * @param config.colors An array with definitions representing colors to be displayed in the color selector.
- * @param config.removeButtonLabel The label for the button responsible for removing the color.
- * @param config.documentColorsLabel The label for the section with document colors.
- * @param config.documentColorsCount The number of document colors inside the dropdown.
- * @param config.colorPickerViewConfig Configuration of the color picker view.
- * @returns The new color selector view.
- */
-export declare function addColorSelectorToDropdown({ dropdownView, colors, columns, removeButtonLabel, colorPickerLabel, documentColorsLabel, documentColorsCount, colorPickerViewConfig }: {
-    dropdownView: ColorSelectorDropdownView;
-    colors: Array<ColorDefinition>;
-    columns: number;
-    removeButtonLabel: string;
-    colorPickerLabel: string;
-    documentColorsLabel?: string;
-    documentColorsCount?: number;
-    colorPickerViewConfig: ColorPickerViewConfig | false;
-}): ColorSelectorView;
-export type ColorSelectorDropdownView = DropdownView & {
-    colorSelectorView?: ColorSelectorView;
-};