@ckeditor/ckeditor5-image 48.2.0 → 48.3.0-alpha.0

package/dist/image/imageinlineediting.d.ts

@@ -1,64 +1,64 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module image/image/imageinlineediting
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { ClipboardPipeline } from '@ckeditor/ckeditor5-clipboard';
-import { ImageEditing } from './imageediting.js';
-import { ImageSizeAttributes } from '../imagesizeattributes.js';
-import { ImageUtils } from '../imageutils.js';
-import { ImagePlaceholder } from './imageplaceholder.js';
+* @module image/image/imageinlineediting
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { ClipboardPipeline } from "@ckeditor/ckeditor5-clipboard";
+import { ImageEditing } from "./imageediting.js";
+import { ImageSizeAttributes } from "../imagesizeattributes.js";
+import { ImageUtils } from "../imageutils.js";
+import { ImagePlaceholder } from "./imageplaceholder.js";
 /**
- * The image inline plugin.
- *
- * It registers:
- *
- * * `<imageInline>` as an inline element in the document schema, and allows `alt`, `src` and `srcset` attributes.
- * * converters for editing and data pipelines.
- * * {@link module:image/image/imagetypecommand~ImageTypeCommand `'imageTypeInline'`} command that converts block images into
- * inline images.
- */
+* The image inline plugin.
+*
+* It registers:
+*
+* * `<imageInline>` as an inline element in the document schema, and allows `alt`, `src` and `srcset` attributes.
+* * converters for editing and data pipelines.
+* * {@link module:image/image/imagetypecommand~ImageTypeCommand `'imageTypeInline'`} command that converts block images into
+* inline images.
+*/
 export declare class ImageInlineEditing extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageEditing, typeof ImageSizeAttributes, typeof ImageUtils, typeof ImagePlaceholder, typeof ClipboardPipeline];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageInlineEditing";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Configures conversion pipelines to support upcasting and downcasting
-     * inline images (inline image widgets) and their attributes.
-     */
-    private _setupConversion;
-    /**
-     * Integrates the plugin with the clipboard pipeline.
-     *
-     * Idea is that the feature should recognize the user's intent when an **block** image is
-     * pasted or dropped. If such an image is pasted/dropped into a non-empty block
-     * (e.g. a paragraph with some text) it gets converted into an inline image on the fly.
-     *
-     * We assume this is the user's intent if they decided to put their image there.
-     *
-     * **Note**: If a block image has a caption, it will not be converted to an inline image
-     * to avoid the confusion. Captions are added on purpose and they should never be lost
-     * in the clipboard pipeline.
-     *
-     * See the `ImageBlockEditing` for the similar integration that works in the opposite direction.
-     *
-     * The feature also sets image `width` and `height` attributes when pasting.
-     */
-    private _setupClipboardIntegration;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[ImageEditing, ImageSizeAttributes, ImageUtils, ImagePlaceholder, ClipboardPipeline]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ImageInlineEditing";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Configures conversion pipelines to support upcasting and downcasting
+	* inline images (inline image widgets) and their attributes.
+	*/
+	private _setupConversion;
+	/**
+	* Integrates the plugin with the clipboard pipeline.
+	*
+	* Idea is that the feature should recognize the user's intent when an **block** image is
+	* pasted or dropped. If such an image is pasted/dropped into a non-empty block
+	* (e.g. a paragraph with some text) it gets converted into an inline image on the fly.
+	*
+	* We assume this is the user's intent if they decided to put their image there.
+	*
+	* **Note**: If a block image has a caption, it will not be converted to an inline image
+	* to avoid the confusion. Captions are added on purpose and they should never be lost
+	* in the clipboard pipeline.
+	*
+	* See the `ImageBlockEditing` for the similar integration that works in the opposite direction.
+	*
+	* The feature also sets image `width` and `height` attributes when pasting.
+	*/
+	private _setupClipboardIntegration;
 }

package/dist/image/imageloadobserver.d.ts

@@ -1,48 +1,48 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module image/image/imageloadobserver
- */
-import { Observer } from '@ckeditor/ckeditor5-engine';
+* @module image/image/imageloadobserver
+*/
+import { Observer } from "@ckeditor/ckeditor5-engine";
 /**
- * Observes all new images added to the {@link module:engine/view/document~ViewDocument},
- * fires {@link module:engine/view/document~ViewDocument#event:imageLoaded} and
- * {@link module:engine/view/document~ViewDocument#event:layoutChanged} event every time when the new image
- * has been loaded.
- *
- * **Note:** This event is not fired for images that has been added to the document and rendered as `complete` (already loaded).
- */
+* Observes all new images added to the {@link module:engine/view/document~ViewDocument},
+* fires {@link module:engine/view/document~ViewDocument#event:imageLoaded} and
+* {@link module:engine/view/document~ViewDocument#event:layoutChanged} event every time when the new image
+* has been loaded.
+*
+* **Note:** This event is not fired for images that has been added to the document and rendered as `complete` (already loaded).
+*/
 export declare class ImageLoadObserver extends Observer {
-    /**
-     * @inheritDoc
-     */
-    observe(domRoot: HTMLElement): void;
-    /**
-     * @inheritDoc
-     */
-    stopObserving(domRoot: HTMLElement): void;
-    /**
-     * Fires {@link module:engine/view/document~ViewDocument#event:layoutChanged} and
-     * {@link module:engine/view/document~ViewDocument#event:imageLoaded}
-     * if observer {@link #isEnabled is enabled}.
-     *
-     * @param domEvent The DOM event.
-     */
-    private _fireEvents;
+	/**
+	* @inheritDoc
+	*/
+	observe(domRoot: HTMLElement): void;
+	/**
+	* @inheritDoc
+	*/
+	override stopObserving(domRoot: HTMLElement): void;
+	/**
+	* Fires {@link module:engine/view/document~ViewDocument#event:layoutChanged} and
+	* {@link module:engine/view/document~ViewDocument#event:imageLoaded}
+	* if observer {@link #isEnabled is enabled}.
+	*
+	* @param domEvent The DOM event.
+	*/
+	private _fireEvents;
 }
 /**
- * Fired when an <img/> DOM element has been loaded in the DOM root.
- *
- * Introduced by {@link module:image/image/imageloadobserver~ImageLoadObserver}.
- *
- * @see module:image/image/imageloadobserver~ImageLoadObserver
- *
- * @eventName module:engine/view/document~ViewDocument#imageLoaded
- * @param data Event data.
- */
+* Fired when an <img/> DOM element has been loaded in the DOM root.
+*
+* Introduced by {@link module:image/image/imageloadobserver~ImageLoadObserver}.
+*
+* @see module:image/image/imageloadobserver~ImageLoadObserver
+*
+* @eventName module:engine/view/document~ViewDocument#imageLoaded
+* @param data Event data.
+*/
 export type ImageLoadedEvent = {
-    name: 'imageLoaded';
-    args: [Event];
+	name: "imageLoaded";
+	args: [Event];
 };

package/dist/image/imageplaceholder.d.ts

@@ -1,43 +1,43 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module image/image/imageplaceholder
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { ImageUtils } from '../imageutils.js';
-import '../../theme/imageplaceholder.css';
+* @module image/image/imageplaceholder
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { ImageUtils } from "../imageutils.js";
+import "../../theme/imageplaceholder.css";
 /**
- * Adds support for image placeholder that is automatically removed when the image is loaded.
- */
+* Adds support for image placeholder that is automatically removed when the image is loaded.
+*/
 export declare class ImagePlaceholder extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageUtils];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImagePlaceholder";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    afterInit(): void;
-    /**
-     * Extends model schema.
-     */
-    private _setupSchema;
-    /**
-     * Registers converters.
-     */
-    private _setupConversion;
-    /**
-     * Prepares listener for image load.
-     */
-    private _setupLoadListener;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[ImageUtils]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ImagePlaceholder";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	afterInit(): void;
+	/**
+	* Extends model schema.
+	*/
+	private _setupSchema;
+	/**
+	* Registers converters.
+	*/
+	private _setupConversion;
+	/**
+	* Prepares listener for image load.
+	*/
+	private _setupLoadListener;
 }

package/dist/image/imagetypecommand.d.ts

@@ -1,44 +1,44 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module image/image/imagetypecommand
- */
-import type { ModelElement } from '@ckeditor/ckeditor5-engine';
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
+* @module image/image/imagetypecommand
+*/
+import { type ModelElement } from "@ckeditor/ckeditor5-engine";
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
 /**
- * The image type command. It changes the type of a selected image, depending on the configuration.
- */
+* The image type command. It changes the type of a selected image, depending on the configuration.
+*/
 export declare class ImageTypeCommand extends Command {
-    /**
-     * Model element name the command converts to.
-     */
-    private readonly _modelElementName;
-    /**
-     * @inheritDoc
-     *
-     * @param modelElementName Model element name the command converts to.
-     */
-    constructor(editor: Editor, modelElementName: 'imageBlock' | 'imageInline');
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command and changes the type of a selected image.
-     *
-     * @fires execute
-     * @param options.setImageSizes Specifies whether the image `width` and `height` attributes should be set automatically.
-     * The default is `true`.
-     * @returns An object containing references to old and new model image elements
-     * (for before and after the change) so external integrations can hook into the decorated
-     * `execute` event and handle this change. `null` if the type change failed.
-     */
-    execute(options?: {
-        setImageSizes?: boolean;
-    }): {
-        oldElement: ModelElement;
-        newElement: ModelElement;
-    } | null;
+	/**
+	* Model element name the command converts to.
+	*/
+	private readonly _modelElementName;
+	/**
+	* @inheritDoc
+	*
+	* @param modelElementName Model element name the command converts to.
+	*/
+	constructor(editor: Editor, modelElementName: "imageBlock" | "imageInline");
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* Executes the command and changes the type of a selected image.
+	*
+	* @fires execute
+	* @param options.setImageSizes Specifies whether the image `width` and `height` attributes should be set automatically.
+	* The default is `true`.
+	* @returns An object containing references to old and new model image elements
+	* (for before and after the change) so external integrations can hook into the decorated
+	* `execute` event and handle this change. `null` if the type change failed.
+	*/
+	override execute(options?: {
+		setImageSizes?: boolean;
+	}): {
+		oldElement: ModelElement;
+		newElement: ModelElement;
+	} | null;
 }

package/dist/image/insertimagecommand.d.ts

@@ -1,70 +1,70 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module image/image/insertimagecommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import { type ArrayOrItem } from '@ckeditor/ckeditor5-utils';
+* @module image/image/insertimagecommand
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
+import { type ArrayOrItem } from "@ckeditor/ckeditor5-utils";
 /**
- * Insert image command.
- *
- * The command is registered by the {@link module:image/image/imageediting~ImageEditing} plugin as `insertImage`
- * and it is also available via aliased `imageInsert` name.
- *
- * In order to insert an image at the current selection position
- * (according to the {@link module:widget/utils~findOptimalInsertionRange} algorithm),
- * execute the command and specify the image source:
- *
- * ```ts
- * editor.execute( 'insertImage', { source: 'http://url.to.the/image' } );
- * ```
- *
- * It is also possible to insert multiple images at once:
- *
- * ```ts
- * editor.execute( 'insertImage', {
- * 	source:  [
- * 		'path/to/image.jpg',
- * 		'path/to/other-image.jpg'
- * 	]
- * } );
- * ```
- *
- * If you want to take the full control over the process, you can specify individual model attributes:
- *
- * ```ts
- * editor.execute( 'insertImage', {
- * 	source:  [
- * 		{ src: 'path/to/image.jpg', alt: 'First alt text' },
- * 		{ src: 'path/to/other-image.jpg', alt: 'Second alt text', customAttribute: 'My attribute value' }
- * 	]
- * } );
- * ```
- */
+* Insert image command.
+*
+* The command is registered by the {@link module:image/image/imageediting~ImageEditing} plugin as `insertImage`
+* and it is also available via aliased `imageInsert` name.
+*
+* In order to insert an image at the current selection position
+* (according to the {@link module:widget/utils~findOptimalInsertionRange} algorithm),
+* execute the command and specify the image source:
+*
+* ```ts
+* editor.execute( 'insertImage', { source: 'http://url.to.the/image' } );
+* ```
+*
+* It is also possible to insert multiple images at once:
+*
+* ```ts
+* editor.execute( 'insertImage', {
+* 	source:  [
+* 		'path/to/image.jpg',
+* 		'path/to/other-image.jpg'
+* 	]
+* } );
+* ```
+*
+* If you want to take the full control over the process, you can specify individual model attributes:
+*
+* ```ts
+* editor.execute( 'insertImage', {
+* 	source:  [
+* 		{ src: 'path/to/image.jpg', alt: 'First alt text' },
+* 		{ src: 'path/to/other-image.jpg', alt: 'Second alt text', customAttribute: 'My attribute value' }
+* 	]
+* } );
+* ```
+*/
 export declare class InsertImageCommand extends Command {
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options Options for the executed command.
-     * @param options.imageType The type of the image to insert. If not specified, the type will be determined automatically.
-     * @param options.source The image source or an array of image sources to insert.
-     * @param options.breakBlock If set to `true`, the block at the selection start will be broken before inserting the image.
-     * See the documentation of the command to learn more about accepted formats.
-     */
-    execute(options: {
-        source: ArrayOrItem<string | Record<string, unknown>>;
-        imageType?: 'imageBlock' | 'imageInline' | null;
-        breakBlock?: boolean;
-    }): void;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* Executes the command.
+	*
+	* @fires execute
+	* @param options Options for the executed command.
+	* @param options.imageType The type of the image to insert. If not specified, the type will be determined automatically.
+	* @param options.source The image source or an array of image sources to insert.
+	* @param options.breakBlock If set to `true`, the block at the selection start will be broken before inserting the image.
+	* See the documentation of the command to learn more about accepted formats.
+	*/
+	override execute(options: {
+		source: ArrayOrItem<string | Record<string, unknown>>;
+		imageType?: "imageBlock" | "imageInline" | null;
+		breakBlock?: boolean;
+	}): void;
 }

package/dist/image/replaceimagesourcecommand.d.ts

@@ -1,51 +1,51 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module image/image/replaceimagesourcecommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import type { ModelWriter, ModelElement } from '@ckeditor/ckeditor5-engine';
+* @module image/image/replaceimagesourcecommand
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
+import type { ModelWriter, ModelElement } from "@ckeditor/ckeditor5-engine";
 /**
- * Replace image source command.
- *
- * Changes image source to the one provided. Can be executed as follows:
- *
- * ```ts
- * editor.execute( 'replaceImageSource', { source: 'http://url.to.the/image' } );
- * ```
- */
+* Replace image source command.
+*
+* Changes image source to the one provided. Can be executed as follows:
+*
+* ```ts
+* editor.execute( 'replaceImageSource', { source: 'http://url.to.the/image' } );
+* ```
+*/
 export declare class ReplaceImageSourceCommand extends Command {
-    value: string | null;
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * @fires execute
-     * @param options Options for the executed command.
-     * @param options.source The image source to replace.
-     */
-    execute(options: {
-        source: string;
-    }): void;
-    /**
-     * Cleanup image attributes that are not relevant to the new source.
-     *
-     * Removed attributes are: 'srcset', 'sizes', 'sources', 'width', 'height', 'alt'.
-     *
-     * This method is decorated, to allow custom cleanup logic.
-     * For example, to remove 'myImageId' attribute after 'src' has changed:
-     *
-     * ```ts
-     * replaceImageSourceCommand.on( 'cleanupImage', ( eventInfo, [ writer, image ] ) => {
-     * 	writer.removeAttribute( 'myImageId', image );
-     * } );
-     * ```
-     */
-    cleanupImage(writer: ModelWriter, image: ModelElement): void;
+	value: string | null;
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* Executes the command.
+	*
+	* @fires execute
+	* @param options Options for the executed command.
+	* @param options.source The image source to replace.
+	*/
+	override execute(options: {
+		source: string;
+	}): void;
+	/**
+	* Cleanup image attributes that are not relevant to the new source.
+	*
+	* Removed attributes are: 'srcset', 'sizes', 'sources', 'width', 'height', 'alt'.
+	*
+	* This method is decorated, to allow custom cleanup logic.
+	* For example, to remove 'myImageId' attribute after 'src' has changed:
+	*
+	* ```ts
+	* replaceImageSourceCommand.on( 'cleanupImage', ( eventInfo, [ writer, image ] ) => {
+	* 	writer.removeAttribute( 'myImageId', image );
+	* } );
+	* ```
+	*/
+	cleanupImage(writer: ModelWriter, image: ModelElement): void;
 }