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

package/dist/types/imagestyle/imagestylecommand.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @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 image/imagestyle/imagestylecommand
+ */
+import type { Element } from 'ckeditor5/src/engine.js';
+import { Command, type Editor } from 'ckeditor5/src/core.js';
+import type { ImageStyleOptionDefinition } from '../imageconfig.js';
+/**
+ * The image style command. It is used to apply {@link module:image/imageconfig~ImageStyleConfig#options image style option}
+ * to a selected image.
+ *
+ * **Note**: Executing this command may change the image model element if the desired style requires an image of a different
+ * type. See {@link module:image/imagestyle/imagestylecommand~ImageStyleCommand#execute} to learn more.
+ */
+export default class ImageStyleCommand extends Command {
+    /**
+     * An object containing names of default style options for the inline and block images.
+     * If there is no default style option for the given image type in the configuration,
+     * the name will be `false`.
+     */
+    private _defaultStyles;
+    /**
+     * The styles handled by this command.
+     */
+    private _styles;
+    /**
+     * Creates an instance of the image style command. When executed, the command applies one of
+     * {@link module:image/imageconfig~ImageStyleConfig#options style options} to the currently selected image.
+     *
+     * @param editor The editor instance.
+     * @param styles The style options that this command supports.
+     */
+    constructor(editor: Editor, styles: Array<ImageStyleOptionDefinition>);
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command and applies the style to the currently selected image:
+     *
+     * ```ts
+     * editor.execute( 'imageStyle', { value: 'side' } );
+     * ```
+     *
+     * **Note**: Executing this command may change the image model element if the desired style requires an image
+     * of a different type. Learn more about {@link module:image/imageconfig~ImageStyleOptionDefinition#modelElements model element}
+     * configuration for the style option.
+     *
+     * @param options.value The name of the style (as configured in {@link module:image/imageconfig~ImageStyleConfig#options}).
+     * @param options.setImageSizes Specifies whether the image `width` and `height` attributes should be set automatically.
+     * The default is `true`.
+     * @fires execute
+     */
+    execute(options?: {
+        value?: string;
+        setImageSizes?: boolean;
+    }): void;
+    /**
+     * Returns `true` if requested style change would trigger the image type change.
+     *
+     * @param requestedStyle The name of the style (as configured in {@link module:image/imageconfig~ImageStyleConfig#options}).
+     * @param imageElement The image model element.
+     */
+    shouldConvertImageType(requestedStyle: string, imageElement: Element): boolean;
+}

package/dist/types/imagestyle/imagestyleediting.d.ts

@@ -0,0 +1,50 @@
+/**
+ * @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 image/imagestyle/imagestyleediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import ImageUtils from '../imageutils.js';
+import type { ImageStyleOptionDefinition } from '../imageconfig.js';
+/**
+ * The image style engine plugin. It sets the default configuration, creates converters and registers
+ * {@link module:image/imagestyle/imagestylecommand~ImageStyleCommand ImageStyleCommand}.
+ */
+export default class ImageStyleEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageStyleEditing";
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageUtils];
+    /**
+     * It contains a list of the normalized and validated style options.
+     *
+     * * Each option contains a complete icon markup.
+     * * The style options not supported by any of the loaded image editing plugins (
+     * {@link module:image/image/imageinlineediting~ImageInlineEditing `ImageInlineEditing`} or
+     * {@link module:image/image/imageblockediting~ImageBlockEditing `ImageBlockEditing`}) are filtered out.
+     *
+     * @internal
+     * @readonly
+     */
+    normalizedStyles?: Array<ImageStyleOptionDefinition>;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Sets the editor conversion taking the presence of
+     * {@link module:image/image/imageinlineediting~ImageInlineEditing `ImageInlineEditing`}
+     * and {@link module:image/image/imageblockediting~ImageBlockEditing `ImageBlockEditing`} plugins into consideration.
+     */
+    private _setupConversion;
+    /**
+     * Registers a post-fixer that will make sure that the style attribute value is correct for a specific image type (block vs inline).
+     */
+    private _setupPostFixer;
+}

package/dist/types/imagestyle/imagestyleui.d.ts

@@ -0,0 +1,56 @@
+/**
+ * @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 image/imagestyle/imagestyleui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import ImageStyleEditing from './imagestyleediting.js';
+import '../../theme/imagestyle.css';
+/**
+ * The image style UI plugin.
+ *
+ * It registers buttons corresponding to the {@link module:image/imageconfig~ImageConfig#styles} configuration.
+ * It also registers the {@link module:image/imagestyle/utils#DEFAULT_DROPDOWN_DEFINITIONS default drop-downs} and the
+ * custom drop-downs defined by the developer in the {@link module:image/imageconfig~ImageConfig#toolbar} configuration.
+ */
+export default class ImageStyleUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageStyleEditing];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageStyleUI";
+    /**
+     * Returns the default localized style titles provided by the plugin.
+     *
+     * The following localized titles corresponding with
+     * {@link module:image/imagestyle/utils#DEFAULT_OPTIONS} are available:
+     *
+     * * `'Wrap text'`,
+     * * `'Break text'`,
+     * * `'In line'`,
+     * * `'Full size image'`,
+     * * `'Side image'`,
+     * * `'Left aligned image'`,
+     * * `'Centered image'`,
+     * * `'Right aligned image'`
+     */
+    get localizedDefaultStylesTitles(): Record<string, string>;
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * Creates a dropdown and stores it in the editor {@link module:ui/componentfactory~ComponentFactory}.
+     */
+    private _createDropdown;
+    /**
+     * Creates a button and stores it in the editor {@link module:ui/componentfactory~ComponentFactory}.
+     */
+    private _createButton;
+    private _executeCommand;
+}

package/dist/types/imagestyle/utils.d.ts

@@ -0,0 +1,101 @@
+/**
+ * @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 image/imagestyle/utils
+ */
+import { type Editor, type PluginCollection } from 'ckeditor5/src/core.js';
+import type { ImageStyleConfig, ImageStyleDropdownDefinition, ImageStyleOptionDefinition } from '../imageconfig.js';
+/**
+ * Default image style options provided by the plugin that can be referred in the {@link module:image/imageconfig~ImageConfig#styles}
+ * configuration.
+ *
+ * There are available 5 styles focused on formatting:
+ *
+ * * **`'alignLeft'`** aligns the inline or block image to the left and wraps it with the text using the `image-style-align-left` class,
+ * * **`'alignRight'`** aligns the inline or block image to the right and wraps it with the text using the `image-style-align-right` class,
+ * * **`'alignCenter'`** centers the block image using the `image-style-align-center` class,
+ * * **`'alignBlockLeft'`** aligns the block image to the left using the `image-style-block-align-left` class,
+ * * **`'alignBlockRight'`** aligns the block image to the right using the `image-style-block-align-right` class,
+ *
+ * and 3 semantic styles:
+ *
+ * * **`'inline'`** is an inline image without any CSS class,
+ * * **`'block'`** is a block image without any CSS class,
+ * * **`'side'`** is a block image styled with the `image-style-side` CSS class.
+ */
+export declare const DEFAULT_OPTIONS: Record<string, ImageStyleOptionDefinition>;
+/**
+ * Default image style icons provided by the plugin that can be referred in the {@link module:image/imageconfig~ImageConfig#styles}
+ * configuration.
+ *
+ * See {@link module:image/imageconfig~ImageStyleOptionDefinition#icon} to learn more.
+ *
+ * There are 7 default icons available: `'full'`, `'left'`, `'inlineLeft'`, `'center'`, `'right'`, `'inlineRight'`, and `'inline'`.
+ */
+export declare const DEFAULT_ICONS: Record<string, string>;
+/**
+ * Default drop-downs provided by the plugin that can be referred in the {@link module:image/imageconfig~ImageConfig#toolbar}
+ * configuration. The drop-downs are containers for the {@link module:image/imageconfig~ImageStyleConfig#options image style options}.
+ *
+ * If both of the `ImageEditing` plugins are loaded, there are 2 predefined drop-downs available:
+ *
+ * * **`'imageStyle:wrapText'`**, which contains the `alignLeft` and `alignRight` options, that is,
+ * those that wraps the text around the image,
+ * * **`'imageStyle:breakText'`**, which contains the `alignBlockLeft`, `alignCenter` and `alignBlockRight` options, that is,
+ * those that breaks the text around the image.
+ */
+export declare const DEFAULT_DROPDOWN_DEFINITIONS: Array<ImageStyleDropdownDefinition>;
+/**
+ * Returns a list of the normalized and validated image style options.
+ *
+ * @param config
+ * @param config.isInlinePluginLoaded
+ * Determines whether the {@link module:image/image/imageblockediting~ImageBlockEditing `ImageBlockEditing`} plugin has been loaded.
+ * @param config.isBlockPluginLoaded
+ * Determines whether the {@link module:image/image/imageinlineediting~ImageInlineEditing `ImageInlineEditing`} plugin has been loaded.
+ * @param config.configuredStyles
+ * The image styles configuration provided in the image styles {@link module:image/imageconfig~ImageConfig#styles configuration}
+ * as a default or custom value.
+ * @returns
+ * * Each of options contains a complete icon markup.
+ * * The image style options not supported by any of the loaded plugins are filtered out.
+ */
+declare function normalizeStyles(config: {
+    isInlinePluginLoaded: boolean;
+    isBlockPluginLoaded: boolean;
+    configuredStyles: ImageStyleConfig;
+}): Array<ImageStyleOptionDefinition>;
+/**
+ * Returns the default image styles configuration depending on the loaded image editing plugins.
+ *
+ * @param isInlinePluginLoaded
+ * Determines whether the {@link module:image/image/imageblockediting~ImageBlockEditing `ImageBlockEditing`} plugin has been loaded.
+ *
+ * @param isBlockPluginLoaded
+ * Determines whether the {@link module:image/image/imageinlineediting~ImageInlineEditing `ImageInlineEditing`} plugin has been loaded.
+ *
+ * @returns
+ * It returns an object with the lists of the image style options and groups defined as strings related to the
+ * {@link module:image/imagestyle/utils#DEFAULT_OPTIONS default options}
+ */
+declare function getDefaultStylesConfiguration(isBlockPluginLoaded: boolean, isInlinePluginLoaded: boolean): ImageStyleConfig;
+/**
+ * Returns a list of the available predefined drop-downs' definitions depending on the loaded image editing plugins.
+ */
+declare function getDefaultDropdownDefinitions(pluginCollection: PluginCollection<Editor>): Array<ImageStyleDropdownDefinition>;
+/**
+ * Displays a console warning with the 'image-style-configuration-definition-invalid' error.
+ */
+declare function warnInvalidStyle(info: object): void;
+declare const _default: {
+    normalizeStyles: typeof normalizeStyles;
+    getDefaultStylesConfiguration: typeof getDefaultStylesConfiguration;
+    getDefaultDropdownDefinitions: typeof getDefaultDropdownDefinitions;
+    warnInvalidStyle: typeof warnInvalidStyle;
+    DEFAULT_OPTIONS: Record<string, ImageStyleOptionDefinition>;
+    DEFAULT_ICONS: Record<string, string>;
+    DEFAULT_DROPDOWN_DEFINITIONS: ImageStyleDropdownDefinition[];
+};
+export default _default;

package/dist/types/imagestyle.d.ts

@@ -0,0 +1,32 @@
+/**
+ * @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 image/imagestyle
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import ImageStyleEditing from './imagestyle/imagestyleediting.js';
+import ImageStyleUI from './imagestyle/imagestyleui.js';
+/**
+ * The image style plugin.
+ *
+ * For a detailed overview of the image styles feature, check the {@glink features/images/images-styles documentation}.
+ *
+ * This is a "glue" plugin which loads the following plugins:
+ * * {@link module:image/imagestyle/imagestyleediting~ImageStyleEditing},
+ * * {@link module:image/imagestyle/imagestyleui~ImageStyleUI}
+ *
+ * It provides a default configuration, which can be extended or overwritten.
+ * Read more about the {@link module:image/imageconfig~ImageConfig#styles image styles configuration}.
+ */
+export default class ImageStyle extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageStyleEditing, typeof ImageStyleUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageStyle";
+}

package/dist/types/imagetextalternative/imagetextalternativecommand.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @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 image/imagetextalternative/imagetextalternativecommand
+ */
+import { Command } from 'ckeditor5/src/core.js';
+/**
+ * The image text alternative command. It is used to change the `alt` attribute of `<imageBlock>` and `<imageInline>` model elements.
+ */
+export default class ImageTextAlternativeCommand extends Command {
+    /**
+     * The command value: `false` if there is no `alt` attribute, otherwise the value of the `alt` attribute.
+     *
+     * @readonly
+     * @observable
+     */
+    value: string | false;
+    /**
+     * @inheritDoc
+     */
+    refresh(): void;
+    /**
+     * Executes the command.
+     *
+     * @fires execute
+     * @param options
+     * @param options.newValue The new value of the `alt` attribute to set.
+     */
+    execute(options: {
+        newValue: string;
+    }): void;
+}

package/dist/types/imagetextalternative/imagetextalternativeediting.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @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 image/imagetextalternative/imagetextalternativeediting
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import ImageUtils from '../imageutils.js';
+/**
+ * The image text alternative editing plugin.
+ *
+ * Registers the `'imageTextAlternative'` command.
+ */
+export default class ImageTextAlternativeEditing extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageUtils];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageTextAlternativeEditing";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}

package/dist/types/imagetextalternative/imagetextalternativeui.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @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 image/imagetextalternative/imagetextalternativeui
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { ContextualBalloon } from 'ckeditor5/src/ui.js';
+/**
+ * The image text alternative UI plugin.
+ *
+ * The plugin uses the {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon}.
+ */
+export default class ImageTextAlternativeUI extends Plugin {
+    /**
+     * The contextual balloon plugin instance.
+     */
+    private _balloon?;
+    /**
+     * A form containing a textarea and buttons, used to change the `alt` text value.
+     */
+    private _form?;
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ContextualBalloon];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageTextAlternativeUI";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Creates a button showing the balloon panel for changing the image text alternative and
+     * registers it in the editor {@link module:ui/componentfactory~ComponentFactory ComponentFactory}.
+     */
+    private _createButton;
+    /**
+     * Creates the {@link module:image/imagetextalternative/ui/textalternativeformview~TextAlternativeFormView}
+     * form.
+     */
+    private _createForm;
+    /**
+     * Shows the {@link #_form} in the {@link #_balloon}.
+     */
+    private _showForm;
+    /**
+     * Removes the {@link #_form} from the {@link #_balloon}.
+     *
+     * @param focusEditable Controls whether the editing view is focused afterwards.
+     */
+    private _hideForm;
+    /**
+     * Returns `true` when the {@link #_form} is the visible view in the {@link #_balloon}.
+     */
+    private get _isVisible();
+    /**
+     * Returns `true` when the {@link #_form} is in the {@link #_balloon}.
+     */
+    private get _isInBalloon();
+}

package/dist/types/imagetextalternative/ui/textalternativeformview.d.ts

@@ -0,0 +1,90 @@
+/**
+ * @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 image/imagetextalternative/ui/textalternativeformview
+ */
+import { ButtonView, FocusCycler, LabeledFieldView, View, ViewCollection, type InputView, type FocusableView } from 'ckeditor5/src/ui.js';
+import { FocusTracker, KeystrokeHandler, type Locale } from 'ckeditor5/src/utils.js';
+import '../../../theme/textalternativeform.css';
+import '@ckeditor/ckeditor5-ui/theme/components/responsive-form/responsiveform.css';
+/**
+ * The TextAlternativeFormView class.
+ */
+export default class TextAlternativeFormView extends View {
+    /**
+     * Tracks information about the DOM focus in the form.
+     */
+    readonly focusTracker: FocusTracker;
+    /**
+     * An instance of the {@link module:utils/keystrokehandler~KeystrokeHandler}.
+     */
+    readonly keystrokes: KeystrokeHandler;
+    /**
+     * An input with a label.
+     */
+    labeledInput: LabeledFieldView<InputView>;
+    /**
+     * A button used to submit the form.
+     */
+    saveButtonView: ButtonView;
+    /**
+     * A button used to cancel the form.
+     */
+    cancelButtonView: ButtonView;
+    /**
+     * A collection of views which can be focused in the form.
+     */
+    protected readonly _focusables: ViewCollection<FocusableView>;
+    /**
+     * Helps cycling over {@link #_focusables} in the form.
+     */
+    protected readonly _focusCycler: FocusCycler;
+    /**
+     * @inheritDoc
+     */
+    constructor(locale: Locale);
+    /**
+     * @inheritDoc
+     */
+    render(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Creates the button view.
+     *
+     * @param label The button label
+     * @param icon The button's icon.
+     * @param className The additional button CSS class name.
+     * @param eventName The event name that the ButtonView#execute event will be delegated to.
+     * @returns The button view instance.
+     */
+    private _createButton;
+    /**
+     * Creates an input with a label.
+     *
+     * @returns Labeled field view instance.
+     */
+    private _createLabeledInputView;
+}
+/**
+ * Fired when the form view is submitted.
+ *
+ * @eventName ~TextAlternativeFormView#submit
+ */
+export type TextAlternativeFormViewSubmitEvent = {
+    name: 'submit';
+    args: [];
+};
+/**
+ * Fired when the form view is canceled.
+ *
+ * @eventName ~TextAlternativeFormView#cancel
+ */
+export type TextAlternativeFormViewCancelEvent = {
+    name: 'cancel';
+    args: [];
+};

package/dist/types/imagetextalternative.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 image/imagetextalternative
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import ImageTextAlternativeEditing from './imagetextalternative/imagetextalternativeediting.js';
+import ImageTextAlternativeUI from './imagetextalternative/imagetextalternativeui.js';
+/**
+ * The image text alternative plugin.
+ *
+ * For a detailed overview, check the {@glink features/images/images-styles image styles} documentation.
+ *
+ * This is a "glue" plugin which loads the
+ *  {@link module:image/imagetextalternative/imagetextalternativeediting~ImageTextAlternativeEditing}
+ * and {@link module:image/imagetextalternative/imagetextalternativeui~ImageTextAlternativeUI} plugins.
+ */
+export default class ImageTextAlternative extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof ImageTextAlternativeEditing, typeof ImageTextAlternativeUI];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageTextAlternative";
+}

package/dist/types/imagetoolbar.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @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 image/imagetoolbar
+ */
+import { Plugin } from 'ckeditor5/src/core.js';
+import { WidgetToolbarRepository } from 'ckeditor5/src/widget.js';
+import ImageUtils from './imageutils.js';
+/**
+ * The image toolbar plugin. It creates and manages the image toolbar (the toolbar displayed when an image is selected).
+ *
+ * For an overview, check the {@glink features/images/images-overview#image-contextual-toolbar image contextual toolbar} documentation.
+ *
+ * Instances of toolbar components (e.g. buttons) are created using the editor's
+ * {@link module:ui/componentfactory~ComponentFactory component factory}
+ * based on the {@link module:image/imageconfig~ImageConfig#toolbar `image.toolbar` configuration option}.
+ *
+ * The toolbar uses the {@link module:ui/panel/balloon/contextualballoon~ContextualBalloon}.
+ */
+export default class ImageToolbar extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get requires(): readonly [typeof WidgetToolbarRepository, typeof ImageUtils];
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "ImageToolbar";
+    /**
+     * @inheritDoc
+     */
+    afterInit(): void;
+}