@ckeditor/ckeditor5-widget 48.2.0 → 48.3.0-alpha.1

package/dist/widgetresize/resizerstate.d.ts

@@ -1,125 +1,126 @@
 /**
- * @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 type { WidgetResizerOptions } from '../widgetresize.js';
-declare const WidgetResizeState_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Observable;
-    prototype: import("@ckeditor/ckeditor5-utils").Observable;
-};
+* @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
+*/
 /**
- * Stores the internal state of a single resizable object.
- */
-export declare class WidgetResizeState extends /* #__PURE__ */ WidgetResizeState_base {
-    /**
-     * The position of the handle that initiated the resizing. E.g. `"top-left"`, `"bottom-right"` etc. or `null`
-     * if unknown.
-     *
-     * @readonly
-     * @observable
-     */
-    activeHandlePosition: string | null;
-    /**
-     * The width (percents) proposed, but not committed yet, in the current resize process.
-     *
-     * @readonly
-     * @observable
-     */
-    proposedWidthPercents: number | null;
-    /**
-     * The width (pixels) proposed, but not committed yet, in the current resize process.
-     *
-     * @readonly
-     * @observable
-     */
-    proposedWidth: number | null;
-    /**
-     * The height (pixels) proposed, but not committed yet, in the current resize process.
-     *
-     * @readonly
-     * @observable
-     */
-    proposedHeight: number | null;
-    /**
-     * @readonly
-     * @observable
-     */
-    proposedHandleHostWidth: number | null;
-    /**
-     * @readonly
-     * @observable
-     */
-    proposedHandleHostHeight: number | null;
-    /**
-     * The reference point of the resizer where the dragging started. It is used to measure the distance the user cursor
-     * traveled, so how much the image should be enlarged.
-     * This information is only known after the DOM was rendered, so it will be updated later.
-     *
-     * @internal
-     */
-    _referenceCoordinates: {
-        x: number;
-        y: number;
-    } | null;
-    /**
-     * Resizer options.
-     */
-    private readonly _options;
-    /**
-     * The original width (pixels) of the resized object when the resize process was started.
-     *
-     * @readonly
-     */
-    private _originalWidth?;
-    /**
-     * The original height (pixels) of the resized object when the resize process was started.
-     *
-     * @readonly
-     */
-    private _originalHeight?;
-    /**
-     * The original width (percents) of the resized object when the resize process was started.
-     *
-     * @readonly
-     */
-    private _originalWidthPercents?;
-    /**
-     * A width to height ratio of the resized image.
-     *
-     * @readonly
-     */
-    private _aspectRatio?;
-    /**
-     * @param options Resizer options.
-     */
-    constructor(options: WidgetResizerOptions);
-    /**
-     * The original width (pixels) of the resized object when the resize process was started.
-     */
-    get originalWidth(): number | undefined;
-    /**
-     * The original height (pixels) of the resized object when the resize process was started.
-     */
-    get originalHeight(): number | undefined;
-    /**
-     * The original width (percents) of the resized object when the resize process was started.
-     */
-    get originalWidthPercents(): number | undefined;
-    /**
-     * A width to height ratio of the resized image.
-     */
-    get aspectRatio(): number | undefined;
-    /**
-     *
-     * @param domResizeHandle The handle used to calculate the reference point.
-     */
-    begin(domResizeHandle: HTMLElement, domHandleHost: HTMLElement, domResizeHost: HTMLElement): void;
-    update(newSize: {
-        width: number;
-        height: number;
-        widthPercents: number;
-        handleHostWidth: number;
-        handleHostHeight: number;
-    }): void;
+* @module widget/widgetresize/resizerstate
+*/
+import { type ObservableMixinConstructor } from "@ckeditor/ckeditor5-utils";
+import type { WidgetResizerOptions } from "../widgetresize.js";
+declare const WidgetResizeStateBase: ObservableMixinConstructor;
+/**
+* Stores the internal state of a single resizable object.
+*/
+export declare class WidgetResizeState extends WidgetResizeStateBase {
+	/**
+	* The position of the handle that initiated the resizing. E.g. `"top-left"`, `"bottom-right"` etc. or `null`
+	* if unknown.
+	*
+	* @readonly
+	* @observable
+	*/
+	activeHandlePosition: string | null;
+	/**
+	* The width (percents) proposed, but not committed yet, in the current resize process.
+	*
+	* @readonly
+	* @observable
+	*/
+	proposedWidthPercents: number | null;
+	/**
+	* The width (pixels) proposed, but not committed yet, in the current resize process.
+	*
+	* @readonly
+	* @observable
+	*/
+	proposedWidth: number | null;
+	/**
+	* The height (pixels) proposed, but not committed yet, in the current resize process.
+	*
+	* @readonly
+	* @observable
+	*/
+	proposedHeight: number | null;
+	/**
+	* @readonly
+	* @observable
+	*/
+	proposedHandleHostWidth: number | null;
+	/**
+	* @readonly
+	* @observable
+	*/
+	proposedHandleHostHeight: number | null;
+	/**
+	* The reference point of the resizer where the dragging started. It is used to measure the distance the user cursor
+	* traveled, so how much the image should be enlarged.
+	* This information is only known after the DOM was rendered, so it will be updated later.
+	*
+	* @internal
+	*/
+	_referenceCoordinates: {
+		x: number;
+		y: number;
+	} | null;
+	/**
+	* Resizer options.
+	*/
+	private readonly _options;
+	/**
+	* The original width (pixels) of the resized object when the resize process was started.
+	*
+	* @readonly
+	*/
+	private _originalWidth?;
+	/**
+	* The original height (pixels) of the resized object when the resize process was started.
+	*
+	* @readonly
+	*/
+	private _originalHeight?;
+	/**
+	* The original width (percents) of the resized object when the resize process was started.
+	*
+	* @readonly
+	*/
+	private _originalWidthPercents?;
+	/**
+	* A width to height ratio of the resized image.
+	*
+	* @readonly
+	*/
+	private _aspectRatio?;
+	/**
+	* @param options Resizer options.
+	*/
+	constructor(options: WidgetResizerOptions);
+	/**
+	* The original width (pixels) of the resized object when the resize process was started.
+	*/
+	get originalWidth(): number | undefined;
+	/**
+	* The original height (pixels) of the resized object when the resize process was started.
+	*/
+	get originalHeight(): number | undefined;
+	/**
+	* The original width (percents) of the resized object when the resize process was started.
+	*/
+	get originalWidthPercents(): number | undefined;
+	/**
+	* A width to height ratio of the resized image.
+	*/
+	get aspectRatio(): number | undefined;
+	/**
+	*
+	* @param domResizeHandle The handle used to calculate the reference point.
+	*/
+	begin(domResizeHandle: HTMLElement, domHandleHost: HTMLElement, domResizeHost: HTMLElement): void;
+	update(newSize: {
+		width: number;
+		height: number;
+		widthPercents: number;
+		handleHostWidth: number;
+		handleHostHeight: number;
+	}): void;
 }
 export {};

package/dist/widgetresize/sizeview.d.ts

@@ -1,57 +1,57 @@
 /**
- * @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 widget/widgetresize/sizeview
- */
-import { View } from '@ckeditor/ckeditor5-ui';
-import type { WidgetResizerOptions } from '../widgetresize.js';
-import { type WidgetResizeState } from './resizerstate.js';
+* @module widget/widgetresize/sizeview
+*/
+import { View } from "@ckeditor/ckeditor5-ui";
+import type { WidgetResizerOptions } from "../widgetresize.js";
+import { type WidgetResizeState } from "./resizerstate.js";
 /**
- * A view displaying the proposed new element size during the resizing.
- *
- * @internal
- */
+* A view displaying the proposed new element size during the resizing.
+*
+* @internal
+*/
 export declare class SizeView extends View {
-    /**
-     * The visibility of the view defined based on the existence of the host proposed dimensions.
-     *
-     * @internal
-     * @observable
-     * @readonly
-     */
-    _isVisible: boolean;
-    /**
-     * The text that will be displayed in the `SizeView` child.
-     * It can be formatted as the pixel values (e.g. 10x20) or the percentage value (e.g. 10%).
-     *
-     * @internal
-     * @observable
-     * @readonly
-     */
-    _label: string;
-    /**
-     * The position of the view defined based on the host size and active handle position.
-     *
-     * @internal
-     * @observable
-     * @readonly
-     */
-    _viewPosition: string;
-    constructor();
-    /**
-     * A method used for binding the `SizeView` instance properties to the `ResizeState` instance observable properties.
-     *
-     * @internal
-     * @param options An object defining the resizer options, used for setting the proper size label.
-     * @param resizeState The `ResizeState` class instance, used for keeping the `SizeView` state up to date.
-     */
-    _bindToState(options: WidgetResizerOptions, resizeState: WidgetResizeState): void;
-    /**
-     * A method used for cleaning up. It removes the bindings and hides the view.
-     *
-     * @internal
-     */
-    _dismiss(): void;
+	/**
+	* The visibility of the view defined based on the existence of the host proposed dimensions.
+	*
+	* @internal
+	* @observable
+	* @readonly
+	*/
+	_isVisible: boolean;
+	/**
+	* The text that will be displayed in the `SizeView` child.
+	* It can be formatted as the pixel values (e.g. 10x20) or the percentage value (e.g. 10%).
+	*
+	* @internal
+	* @observable
+	* @readonly
+	*/
+	_label: string;
+	/**
+	* The position of the view defined based on the host size and active handle position.
+	*
+	* @internal
+	* @observable
+	* @readonly
+	*/
+	_viewPosition: string;
+	constructor();
+	/**
+	* A method used for binding the `SizeView` instance properties to the `ResizeState` instance observable properties.
+	*
+	* @internal
+	* @param options An object defining the resizer options, used for setting the proper size label.
+	* @param resizeState The `ResizeState` class instance, used for keeping the `SizeView` state up to date.
+	*/
+	_bindToState(options: WidgetResizerOptions, resizeState: WidgetResizeState): void;
+	/**
+	* A method used for cleaning up. It removes the bindings and hides the view.
+	*
+	* @internal
+	*/
+	_dismiss(): void;
 }

package/dist/widgetresize.d.ts

@@ -1,129 +1,129 @@
 /**
- * @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 widget/widgetresize
- */
-import { WidgetResizer } from './widgetresize/resizer.js';
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { type ModelElement, type ViewContainerElement } from '@ckeditor/ckeditor5-engine';
-import '../theme/widgetresize.css';
+* @module widget/widgetresize
+*/
+import { WidgetResizer } from "./widgetresize/resizer.js";
+import { Plugin, type Editor } from "@ckeditor/ckeditor5-core";
+import { type ModelElement, type ViewContainerElement } from "@ckeditor/ckeditor5-engine";
+import "../theme/widgetresize.css";
 /**
- * The widget resize feature plugin.
- *
- * Use the {@link module:widget/widgetresize~WidgetResize#attachTo} method to create a resizer for the specified widget.
- */
+* The widget resize feature plugin.
+*
+* Use the {@link module:widget/widgetresize~WidgetResize#attachTo} method to create a resizer for the specified widget.
+*/
 export declare class WidgetResize extends Plugin {
-    /**
-     * The currently selected resizer.
-     *
-     * @observable
-     */
-    selectedResizer: WidgetResizer | null;
-    /**
-     * References an active resizer.
-     *
-     * Active resizer means a resizer which handle is actively used by the end user.
-     *
-     * @internal
-     * @observable
-     */
-    _activeResizer: WidgetResizer | null;
-    /**
-     * A map of resizers created using this plugin instance.
-     */
-    private _resizers;
-    private _observer;
-    private _redrawSelectedResizerThrottled;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "WidgetResize";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Redraws the selected resizer if there is any selected resizer and if it is visible.
-     */
-    redrawSelectedResizer(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Marks resizer as selected.
-     */
-    select(resizer: WidgetResizer): void;
-    /**
-     * Deselects currently set resizer.
-     */
-    deselect(): void;
-    /**
-     * @param options Resizer options.
-     */
-    attachTo(options: WidgetResizerOptions): WidgetResizer;
-    /**
-     * Returns a resizer created for a given view element (widget element).
-     *
-     * @param viewElement View element associated with the resizer.
-     */
-    getResizerByViewElement(viewElement: ViewContainerElement): WidgetResizer | undefined;
-    /**
-     * Returns a resizer that contains a given resize handle.
-     */
-    private _getResizerByHandle;
-    /**
-     * @param domEventData Native DOM event.
-     */
-    private _mouseDownListener;
-    /**
-     * @param domEventData Native DOM event.
-     */
-    private _mouseMoveListener;
-    private _mouseUpListener;
+	/**
+	* The currently selected resizer.
+	*
+	* @observable
+	*/
+	selectedResizer: WidgetResizer | null;
+	/**
+	* References an active resizer.
+	*
+	* Active resizer means a resizer which handle is actively used by the end user.
+	*
+	* @internal
+	* @observable
+	*/
+	_activeResizer: WidgetResizer | null;
+	/**
+	* A map of resizers created using this plugin instance.
+	*/
+	private _resizers;
+	private _observer;
+	private _redrawSelectedResizerThrottled;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "WidgetResize";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Redraws the selected resizer if there is any selected resizer and if it is visible.
+	*/
+	redrawSelectedResizer(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* Marks resizer as selected.
+	*/
+	select(resizer: WidgetResizer): void;
+	/**
+	* Deselects currently set resizer.
+	*/
+	deselect(): void;
+	/**
+	* @param options Resizer options.
+	*/
+	attachTo(options: WidgetResizerOptions): WidgetResizer;
+	/**
+	* Returns a resizer created for a given view element (widget element).
+	*
+	* @param viewElement View element associated with the resizer.
+	*/
+	getResizerByViewElement(viewElement: ViewContainerElement): WidgetResizer | undefined;
+	/**
+	* Returns a resizer that contains a given resize handle.
+	*/
+	private _getResizerByHandle;
+	/**
+	* @param domEventData Native DOM event.
+	*/
+	private _mouseDownListener;
+	/**
+	* @param domEventData Native DOM event.
+	*/
+	private _mouseMoveListener;
+	private _mouseUpListener;
 }
 /**
- * Interface describing a resizer. It allows to specify the resizing host, custom logic for calculating aspect ratio, etc.
- */
+* Interface describing a resizer. It allows to specify the resizing host, custom logic for calculating aspect ratio, etc.
+*/
 export interface WidgetResizerOptions {
-    /**
-     * Editor instance associated with the resizer.
-     */
-    editor: Editor;
-    modelElement: ModelElement;
-    /**
-     * A view of an element to be resized. Typically it's the main widget's view instance.
-     */
-    viewElement: ViewContainerElement;
-    unit?: 'px' | '%';
-    /**
-     * A callback to be executed once the resizing process is done.
-     *
-     * It receives a `Number` (`newValue`) as a parameter.
-     *
-     * For example, {@link module:image/imageresize~ImageResize} uses it to execute the resize image command
-     * which puts the new value into the model.
-     *
-     * ```ts
-     * {
-     *	editor,
-     *	modelElement: data.item,
-     *	viewElement: widget,
-     *
-     *	onCommit( newValue ) {
-     *		editor.execute( 'resizeImage', { width: newValue } );
-     *	}
-     * };
-     * ```
-     */
-    onCommit: (newValue: string) => void;
-    getResizeHost: (widgetWrapper: HTMLElement) => HTMLElement;
-    getHandleHost: (widgetWrapper: HTMLElement) => HTMLElement;
-    isCentered?: (resizer: WidgetResizer) => boolean;
+	/**
+	* Editor instance associated with the resizer.
+	*/
+	editor: Editor;
+	modelElement: ModelElement;
+	/**
+	* A view of an element to be resized. Typically it's the main widget's view instance.
+	*/
+	viewElement: ViewContainerElement;
+	unit?: "px" | "%";
+	/**
+	* A callback to be executed once the resizing process is done.
+	*
+	* It receives a `Number` (`newValue`) as a parameter.
+	*
+	* For example, {@link module:image/imageresize~ImageResize} uses it to execute the resize image command
+	* which puts the new value into the model.
+	*
+	* ```ts
+	* {
+	*	editor,
+	*	modelElement: data.item,
+	*	viewElement: widget,
+	*
+	*	onCommit( newValue ) {
+	*		editor.execute( 'resizeImage', { width: newValue } );
+	*	}
+	* };
+	* ```
+	*/
+	onCommit: (newValue: string) => void;
+	getResizeHost: (widgetWrapper: HTMLElement) => HTMLElement;
+	getHandleHost: (widgetWrapper: HTMLElement) => HTMLElement;
+	isCentered?: (resizer: WidgetResizer) => boolean;
 }