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

package/dist/imagecaption/imagecaptionutils.d.ts

@@ -1,42 +1,42 @@
 /**
- * @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/imagecaption/imagecaptionutils
- */
-import type { ModelDocumentSelection, ModelElement, ModelSelection, ViewElement, Match } from '@ckeditor/ckeditor5-engine';
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { ImageUtils } from '../imageutils.js';
+* @module image/imagecaption/imagecaptionutils
+*/
+import type { ModelDocumentSelection, ModelElement, ModelSelection, ViewElement, Match } from "@ckeditor/ckeditor5-engine";
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { ImageUtils } from "../imageutils.js";
 /**
- * The image caption utilities plugin.
- */
+* The image caption utilities plugin.
+*/
 export declare class ImageCaptionUtils extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageCaptionUtils";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageUtils];
-    /**
-     * Returns the caption model element from a given image element. Returns `null` if no caption is found.
-     */
-    getCaptionFromImageModelElement(imageModelElement: ModelElement): ModelElement | null;
-    /**
-     * Returns the caption model element for a model selection. Returns `null` if the selection has no caption element ancestor.
-     */
-    getCaptionFromModelSelection(selection: ModelSelection | ModelDocumentSelection): ModelElement | null;
-    /**
-     * {@link module:engine/view/matcher~Matcher} pattern. Checks if a given element is a `<figcaption>` element that is placed
-     * inside the image `<figure>` element.
-     * @returns Returns the object accepted by {@link module:engine/view/matcher~Matcher} or `null` if the element
-     * cannot be matched.
-     */
-    matchImageCaptionViewElement(element: ViewElement): Match | null;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ImageCaptionUtils";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[ImageUtils]>;
+	/**
+	* Returns the caption model element from a given image element. Returns `null` if no caption is found.
+	*/
+	getCaptionFromImageModelElement(imageModelElement: ModelElement): ModelElement | null;
+	/**
+	* Returns the caption model element for a model selection. Returns `null` if the selection has no caption element ancestor.
+	*/
+	getCaptionFromModelSelection(selection: ModelSelection | ModelDocumentSelection): ModelElement | null;
+	/**
+	* {@link module:engine/view/matcher~Matcher} pattern. Checks if a given element is a `<figcaption>` element that is placed
+	* inside the image `<figure>` element.
+	* @returns Returns the object accepted by {@link module:engine/view/matcher~Matcher} or `null` if the element
+	* cannot be matched.
+	*/
+	matchImageCaptionViewElement(element: ViewElement): Match | null;
 }

package/dist/imagecaption/toggleimagecaptioncommand.d.ts

@@ -1,66 +1,66 @@
 /**
- * @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
- */
-import { Command } from '@ckeditor/ckeditor5-core';
+* @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
+*/
+import { Command } from "@ckeditor/ckeditor5-core";
 /**
- * The toggle image caption command.
- *
- * This command is registered by {@link module:image/imagecaption/imagecaptionediting~ImageCaptionEditing} as the
- * `'toggleImageCaption'` editor command.
- *
- * Executing this command:
- *
- * * either adds or removes the image caption of a selected image (depending on whether the caption is present or not),
- * * removes the image caption if the selection is anchored in one.
- *
- * ```ts
- * // Toggle the presence of the caption.
- * editor.execute( 'toggleImageCaption' );
- * ```
- *
- * **Note**: Upon executing this command, the selection will be set on the image if previously anchored in the caption element.
- *
- * **Note**: You can move the selection to the caption right away as it shows up upon executing this command by using
- * the `focusCaptionOnShow` option:
- *
- * ```ts
- * editor.execute( 'toggleImageCaption', { focusCaptionOnShow: true } );
- * ```
- */
+* The toggle image caption command.
+*
+* This command is registered by {@link module:image/imagecaption/imagecaptionediting~ImageCaptionEditing} as the
+* `'toggleImageCaption'` editor command.
+*
+* Executing this command:
+*
+* * either adds or removes the image caption of a selected image (depending on whether the caption is present or not),
+* * removes the image caption if the selection is anchored in one.
+*
+* ```ts
+* // Toggle the presence of the caption.
+* editor.execute( 'toggleImageCaption' );
+* ```
+*
+* **Note**: Upon executing this command, the selection will be set on the image if previously anchored in the caption element.
+*
+* **Note**: You can move the selection to the caption right away as it shows up upon executing this command by using
+* the `focusCaptionOnShow` option:
+*
+* ```ts
+* editor.execute( 'toggleImageCaption', { focusCaptionOnShow: true } );
+* ```
+*/
 export declare class ToggleImageCaptionCommand extends Command {
-    value: boolean;
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Executes the command.
-     *
-     * ```ts
-     * editor.execute( 'toggleImageCaption' );
-     * ```
-     *
-     * @param options Options for the executed command.
-     * @param options.focusCaptionOnShow When true and the caption shows up, the selection will be moved into it straight away.
-     * @fires execute
-     */
-    execute(options?: {
-        focusCaptionOnShow?: boolean;
-    }): void;
-    /**
-     * Shows the caption of the `<imageBlock>` or `<imageInline>`. Also:
-     *
-     * * it converts `<imageInline>` to `<imageBlock>` to show the caption,
-     * * it attempts to restore the caption content from the `ImageCaptionEditing` caption registry,
-     * * it moves the selection to the caption right away, it the `focusCaptionOnShow` option was set.
-     */
-    private _showImageCaption;
-    /**
-     * Hides the caption of a selected image (or an image caption the selection is anchored to).
-     *
-     * The content of the caption is stored in the `ImageCaptionEditing` caption registry to make this
-     * a reversible action.
-     */
-    private _hideImageCaption;
+	value: boolean;
+	/**
+	* @inheritDoc
+	*/
+	override refresh(): void;
+	/**
+	* Executes the command.
+	*
+	* ```ts
+	* editor.execute( 'toggleImageCaption' );
+	* ```
+	*
+	* @param options Options for the executed command.
+	* @param options.focusCaptionOnShow When true and the caption shows up, the selection will be moved into it straight away.
+	* @fires execute
+	*/
+	override execute(options?: {
+		focusCaptionOnShow?: boolean;
+	}): void;
+	/**
+	* Shows the caption of the `<imageBlock>` or `<imageInline>`. Also:
+	*
+	* * it converts `<imageInline>` to `<imageBlock>` to show the caption,
+	* * it attempts to restore the caption content from the `ImageCaptionEditing` caption registry,
+	* * it moves the selection to the caption right away, it the `focusCaptionOnShow` option was set.
+	*/
+	private _showImageCaption;
+	/**
+	* Hides the caption of a selected image (or an image caption the selection is anchored to).
+	*
+	* The content of the caption is stored in the `ImageCaptionEditing` caption registry to make this
+	* a reversible action.
+	*/
+	private _hideImageCaption;
 }

package/dist/imagecaption.d.ts

@@ -1,30 +1,30 @@
 /**
- * @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/imagecaption
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { ImageCaptionEditing } from './imagecaption/imagecaptionediting.js';
-import { ImageCaptionUI } from './imagecaption/imagecaptionui.js';
-import '../theme/imagecaption.css';
+* @module image/imagecaption
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { ImageCaptionEditing } from "./imagecaption/imagecaptionediting.js";
+import { ImageCaptionUI } from "./imagecaption/imagecaptionui.js";
+import "../theme/imagecaption.css";
 /**
- * The image caption plugin.
- *
- * For a detailed overview, check the {@glink features/images/images-captions image caption} documentation.
- */
+* The image caption plugin.
+*
+* For a detailed overview, check the {@glink features/images/images-captions image caption} documentation.
+*/
 export declare class ImageCaption extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof ImageCaptionEditing, typeof ImageCaptionUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "ImageCaption";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[ImageCaptionEditing, ImageCaptionUI]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "ImageCaption";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
 }