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

package/dist/widget.d.ts

@@ -1,118 +1,118 @@
 /**
- * @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/widget
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { type ModelElement, type ModelNode, type ViewPosition, type ModelRange } from '@ckeditor/ckeditor5-engine';
-import { Delete } from '@ckeditor/ckeditor5-typing';
-import { WidgetTypeAround } from './widgettypearound/widgettypearound.js';
-import '../theme/widget.css';
+* @module widget/widget
+*/
+import { Plugin, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { type ModelElement, type ModelNode, type ViewPosition, type ModelRange } from "@ckeditor/ckeditor5-engine";
+import { Delete } from "@ckeditor/ckeditor5-typing";
+import { WidgetTypeAround } from "./widgettypearound/widgettypearound.js";
+import "../theme/widget.css";
 /**
- * The widget plugin. It enables base support for widgets.
- *
- * See {@glink api/widget package page} for more details and documentation.
- *
- * This plugin enables multiple behaviors required by widgets:
- *
- * * The model to view selection converter for the editing pipeline (it handles widget custom selection rendering).
- * If a converted selection wraps around a widget element, that selection is marked as
- * {@link module:engine/view/selection~ViewSelection#isFake fake}. Additionally, the `ck-widget_selected` CSS class
- * is added to indicate that widget has been selected.
- * * The mouse and keyboard events handling on and around widget elements.
- */
+* The widget plugin. It enables base support for widgets.
+*
+* See {@glink api/widget package page} for more details and documentation.
+*
+* This plugin enables multiple behaviors required by widgets:
+*
+* * The model to view selection converter for the editing pipeline (it handles widget custom selection rendering).
+* If a converted selection wraps around a widget element, that selection is marked as
+* {@link module:engine/view/selection~ViewSelection#isFake fake}. Additionally, the `ck-widget_selected` CSS class
+* is added to indicate that widget has been selected.
+* * The mouse and keyboard events handling on and around widget elements.
+*/
 export declare class Widget extends Plugin {
-    /**
-     * Holds previously selected widgets.
-     */
-    private _previouslySelected;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Widget";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof WidgetTypeAround, typeof Delete];
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Handles {@link module:engine/view/document~ViewDocument#event:mousedown mousedown} events on widget elements.
-     */
-    private _onMousedown;
-    /**
-     * Handles {@link module:engine/view/document~ViewDocument#event:pointerdown pointerdown} events on widget elements.
-     */
-    private _onPointerdown;
-    /**
-     * Selects entire block content, e.g. on triple click it selects entire paragraph.
-     */
-    private _selectBlockContent;
-    /**
-     * Handles {@link module:engine/view/document~ViewDocument#event:keydown keydown} events and changes
-     * the model selection when:
-     *
-     * * arrow key is pressed when the widget is selected,
-     * * the selection is next to a widget and the widget should become selected upon the arrow key press.
-     *
-     * See {@link #_preventDefaultOnArrowKeyPress}.
-     */
-    private _handleSelectionChangeOnArrowKeyPress;
-    /**
-     * Handles {@link module:engine/view/document~ViewDocument#event:keydown keydown} events and prevents
-     * the default browser behavior to make sure the fake selection is not being moved from a fake selection
-     * container.
-     *
-     * See {@link #_handleSelectionChangeOnArrowKeyPress}.
-     */
-    private _preventDefaultOnArrowKeyPress;
-    /**
-     * Handles delete keys: backspace and delete.
-     *
-     * @param isForward Set to true if delete was performed in forward direction.
-     * @returns Returns `true` if keys were handled correctly.
-     */
-    private _handleDelete;
-    /**
-     * Sets {@link module:engine/model/selection~ModelSelection document's selection} over given element.
-     *
-     * @internal
-     */
-    _setSelectionOverElement(element: ModelNode): void;
-    /**
-     * Checks if {@link module:engine/model/element~ModelElement element} placed next to the current
-     * {@link module:engine/model/selection~ModelSelection model selection} exists and is marked in
-     * {@link module:engine/model/schema~ModelSchema schema} as `object`.
-     *
-     * @internal
-     * @param forward Direction of checking.
-     */
-    _getObjectElementNextToSelection(forward: boolean): ModelElement | null;
-    /**
-     * Removes CSS class from previously selected widgets.
-     */
-    private _clearPreviouslySelectedWidgets;
-    /**
-     * Moves the document selection into the next editable or block widget.
-     */
-    private _selectNextEditable;
-    /**
-     * Looks for next focus point in the document starting from the given view position and direction.
-     * The focus point is either a block widget or an editable.
-     *
-     * @internal
-     */
-    _findNextFocusRange(startPosition: ViewPosition, direction: 'backward' | 'forward'): ModelRange | null;
-    /**
-     * Updates the document selection so that it selects first ancestor widget.
-     */
-    private _selectAncestorWidget;
+	/**
+	* Holds previously selected widgets.
+	*/
+	private _previouslySelected;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "Widget";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[WidgetTypeAround, Delete]>;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Handles {@link module:engine/view/document~ViewDocument#event:mousedown mousedown} events on widget elements.
+	*/
+	private _onMousedown;
+	/**
+	* Handles {@link module:engine/view/document~ViewDocument#event:pointerdown pointerdown} events on widget elements.
+	*/
+	private _onPointerdown;
+	/**
+	* Selects entire block content, e.g. on triple click it selects entire paragraph.
+	*/
+	private _selectBlockContent;
+	/**
+	* Handles {@link module:engine/view/document~ViewDocument#event:keydown keydown} events and changes
+	* the model selection when:
+	*
+	* * arrow key is pressed when the widget is selected,
+	* * the selection is next to a widget and the widget should become selected upon the arrow key press.
+	*
+	* See {@link #_preventDefaultOnArrowKeyPress}.
+	*/
+	private _handleSelectionChangeOnArrowKeyPress;
+	/**
+	* Handles {@link module:engine/view/document~ViewDocument#event:keydown keydown} events and prevents
+	* the default browser behavior to make sure the fake selection is not being moved from a fake selection
+	* container.
+	*
+	* See {@link #_handleSelectionChangeOnArrowKeyPress}.
+	*/
+	private _preventDefaultOnArrowKeyPress;
+	/**
+	* Handles delete keys: backspace and delete.
+	*
+	* @param isForward Set to true if delete was performed in forward direction.
+	* @returns Returns `true` if keys were handled correctly.
+	*/
+	private _handleDelete;
+	/**
+	* Sets {@link module:engine/model/selection~ModelSelection document's selection} over given element.
+	*
+	* @internal
+	*/
+	_setSelectionOverElement(element: ModelNode): void;
+	/**
+	* Checks if {@link module:engine/model/element~ModelElement element} placed next to the current
+	* {@link module:engine/model/selection~ModelSelection model selection} exists and is marked in
+	* {@link module:engine/model/schema~ModelSchema schema} as `object`.
+	*
+	* @internal
+	* @param forward Direction of checking.
+	*/
+	_getObjectElementNextToSelection(forward: boolean): ModelElement | null;
+	/**
+	* Removes CSS class from previously selected widgets.
+	*/
+	private _clearPreviouslySelectedWidgets;
+	/**
+	* Moves the document selection into the next editable or block widget.
+	*/
+	private _selectNextEditable;
+	/**
+	* Looks for next focus point in the document starting from the given view position and direction.
+	* The focus point is either a block widget or an editable.
+	*
+	* @internal
+	*/
+	_findNextFocusRange(startPosition: ViewPosition, direction: "backward" | "forward"): ModelRange | null;
+	/**
+	* Updates the document selection so that it selects first ancestor widget.
+	*/
+	private _selectAncestorWidget;
 }

package/dist/widgetresize/resizer.d.ts

@@ -1,177 +1,174 @@
 /**
- * @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 { Rect, type DecoratedMethodEvent } from '@ckeditor/ckeditor5-utils';
-import { WidgetResizeState } from './resizerstate.js';
-import type { WidgetResizerOptions } from '../widgetresize.js';
-declare const WidgetResizer_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
+*/
+import { Rect, type DecoratedMethodEvent, type ObservableMixinConstructor } from "@ckeditor/ckeditor5-utils";
+import { WidgetResizeState } from "./resizerstate.js";
+import type { WidgetResizerOptions } from "../widgetresize.js";
+declare const WidgetResizerBase: ObservableMixinConstructor;
 /**
- * Represents a resizer for a single resizable object.
- */
-export declare class WidgetResizer extends /* #__PURE__ */ WidgetResizer_base {
-    /**
-     * Flag that indicates whether resizer can be used.
-     *
-     * @observable
-     */
-    isEnabled: boolean;
-    /**
-     * Flag that indicates that resizer is currently focused.
-     *
-     * @observable
-     */
-    isSelected: boolean;
-    /**
-     * Flag that indicates whether resizer is rendered (visible on the screen).
-     *
-     * @readonly
-     * @observable
-     */
-    isVisible: boolean;
-    /**
-     * Stores the state of the resizable host geometry, such as the original width, the currently proposed height, etc.
-     *
-     * Note that a new state is created for each resize transaction.
-     */
-    private _state;
-    /**
-     * A view displaying the proposed new element size during the resizing.
-     */
-    private _sizeView;
-    /**
-     * Options passed to the {@link #constructor}.
-     */
-    private _options;
-    /**
-     * A wrapper that is controlled by the resizer. This is usually a widget element.
-     */
-    private _viewResizerWrapper;
-    /**
-     * The width of the resized {@link module:widget/widgetresize~WidgetResizerOptions#viewElement viewElement} before the resizing started.
-     */
-    private _initialViewWidth;
-    /**
-     * @param options Resizer options.
-     */
-    constructor(options: WidgetResizerOptions);
-    /**
-     * Stores the state of the resizable host geometry, such as the original width, the currently proposed height, etc.
-     *
-     * Note that a new state is created for each resize transaction.
-     */
-    get state(): WidgetResizeState;
-    /**
-     * Makes resizer visible in the UI.
-     */
-    show(): void;
-    /**
-     * Hides resizer in the UI.
-     */
-    hide(): void;
-    /**
-     * Attaches the resizer to the DOM.
-     */
-    attach(): void;
-    /**
-     * Starts the resizing process.
-     *
-     * Creates a new {@link #state} for the current process.
-     *
-     * @fires begin
-     * @param domResizeHandle Clicked handle.
-     */
-    begin(domResizeHandle: HTMLElement): void;
-    /**
-     * Updates the proposed size based on `domEventData`.
-     *
-     * @fires updateSize
-     */
-    updateSize(domEventData: MouseEvent): void;
-    /**
-     * Applies the geometry proposed with the resizer.
-     *
-     * @fires commit
-     */
-    commit(): void;
-    /**
-     * Cancels and rejects the proposed resize dimensions, hiding the UI.
-     *
-     * @fires cancel
-     */
-    cancel(): void;
-    /**
-     * Destroys the resizer.
-     */
-    destroy(): void;
-    /**
-     * Redraws the resizer.
-     *
-     * @param handleHostRect Handle host rectangle might be given to improve performance.
-     */
-    redraw(handleHostRect?: Rect): void;
-    containsHandle(domElement: HTMLElement): boolean;
-    static isResizeHandle(domElement: HTMLElement): boolean;
-    /**
-     * Cleans up the context state.
-     */
-    private _cleanup;
-    /**
-     * Calculates the proposed size as the resize handles are dragged.
-     *
-     * @param domEventData Event data that caused the size update request. It should be used to calculate the proposed size.
-     */
-    private _proposeNewSize;
-    /**
-     * Obtains the resize host.
-     *
-     * Resize host is an object that receives dimensions which are the result of resizing.
-     */
-    private _getResizeHost;
-    /**
-     * Obtains the handle host.
-     *
-     * Handle host is an object that the handles are aligned to.
-     *
-     * Handle host will not always be an entire widget itself. Take an image as an example. The image widget
-     * contains an image and a caption. Only the image should be surrounded with handles.
-     */
-    private _getHandleHost;
-    /**
-     * DOM container of the entire resize UI.
-     *
-     * Note that this property will have a value only after the element bound with the resizer is rendered
-     * (otherwise `null`).
-     */
-    private get _domResizerWrapper();
-    /**
-     * Renders the resize handles in the DOM.
-     *
-     * @param domElement The resizer wrapper.
-     */
-    private _appendHandles;
-    /**
-     * Sets up the {@link #_sizeView} property and adds it to the passed `domElement`.
-     */
-    private _appendSizeUI;
+* Represents a resizer for a single resizable object.
+*/
+export declare class WidgetResizer extends WidgetResizerBase {
+	/**
+	* Flag that indicates whether resizer can be used.
+	*
+	* @observable
+	*/
+	isEnabled: boolean;
+	/**
+	* Flag that indicates that resizer is currently focused.
+	*
+	* @observable
+	*/
+	isSelected: boolean;
+	/**
+	* Flag that indicates whether resizer is rendered (visible on the screen).
+	*
+	* @readonly
+	* @observable
+	*/
+	isVisible: boolean;
+	/**
+	* Stores the state of the resizable host geometry, such as the original width, the currently proposed height, etc.
+	*
+	* Note that a new state is created for each resize transaction.
+	*/
+	private _state;
+	/**
+	* A view displaying the proposed new element size during the resizing.
+	*/
+	private _sizeView;
+	/**
+	* Options passed to the {@link #constructor}.
+	*/
+	private _options;
+	/**
+	* A wrapper that is controlled by the resizer. This is usually a widget element.
+	*/
+	private _viewResizerWrapper;
+	/**
+	* The width of the resized {@link module:widget/widgetresize~WidgetResizerOptions#viewElement viewElement} before the resizing started.
+	*/
+	private _initialViewWidth;
+	/**
+	* @param options Resizer options.
+	*/
+	constructor(options: WidgetResizerOptions);
+	/**
+	* Stores the state of the resizable host geometry, such as the original width, the currently proposed height, etc.
+	*
+	* Note that a new state is created for each resize transaction.
+	*/
+	get state(): WidgetResizeState;
+	/**
+	* Makes resizer visible in the UI.
+	*/
+	show(): void;
+	/**
+	* Hides resizer in the UI.
+	*/
+	hide(): void;
+	/**
+	* Attaches the resizer to the DOM.
+	*/
+	attach(): void;
+	/**
+	* Starts the resizing process.
+	*
+	* Creates a new {@link #state} for the current process.
+	*
+	* @fires begin
+	* @param domResizeHandle Clicked handle.
+	*/
+	begin(domResizeHandle: HTMLElement): void;
+	/**
+	* Updates the proposed size based on `domEventData`.
+	*
+	* @fires updateSize
+	*/
+	updateSize(domEventData: MouseEvent): void;
+	/**
+	* Applies the geometry proposed with the resizer.
+	*
+	* @fires commit
+	*/
+	commit(): void;
+	/**
+	* Cancels and rejects the proposed resize dimensions, hiding the UI.
+	*
+	* @fires cancel
+	*/
+	cancel(): void;
+	/**
+	* Destroys the resizer.
+	*/
+	destroy(): void;
+	/**
+	* Redraws the resizer.
+	*
+	* @param handleHostRect Handle host rectangle might be given to improve performance.
+	*/
+	redraw(handleHostRect?: Rect): void;
+	containsHandle(domElement: HTMLElement): boolean;
+	static isResizeHandle(domElement: HTMLElement): boolean;
+	/**
+	* Cleans up the context state.
+	*/
+	private _cleanup;
+	/**
+	* Calculates the proposed size as the resize handles are dragged.
+	*
+	* @param domEventData Event data that caused the size update request. It should be used to calculate the proposed size.
+	*/
+	private _proposeNewSize;
+	/**
+	* Obtains the resize host.
+	*
+	* Resize host is an object that receives dimensions which are the result of resizing.
+	*/
+	private _getResizeHost;
+	/**
+	* Obtains the handle host.
+	*
+	* Handle host is an object that the handles are aligned to.
+	*
+	* Handle host will not always be an entire widget itself. Take an image as an example. The image widget
+	* contains an image and a caption. Only the image should be surrounded with handles.
+	*/
+	private _getHandleHost;
+	/**
+	* DOM container of the entire resize UI.
+	*
+	* Note that this property will have a value only after the element bound with the resizer is rendered
+	* (otherwise `null`).
+	*/
+	private get _domResizerWrapper();
+	/**
+	* Renders the resize handles in the DOM.
+	*
+	* @param domElement The resizer wrapper.
+	*/
+	private _appendHandles;
+	/**
+	* Sets up the {@link #_sizeView} property and adds it to the passed `domElement`.
+	*/
+	private _appendSizeUI;
 }
 /**
- * @eventName ~WidgetResizer#begin
- */
-export type WidgetResizerBeginEvent = DecoratedMethodEvent<WidgetResizer, 'begin'>;
+* @eventName ~WidgetResizer#begin
+*/
+export type WidgetResizerBeginEvent = DecoratedMethodEvent<WidgetResizer, "begin">;
 /**
- * @eventName ~WidgetResizer#cancel
- */
-export type WidgetResizerCancelEvent = DecoratedMethodEvent<WidgetResizer, 'cancel'>;
+* @eventName ~WidgetResizer#cancel
+*/
+export type WidgetResizerCancelEvent = DecoratedMethodEvent<WidgetResizer, "cancel">;
 /**
- * @eventName ~WidgetResizer#commit
- */
-export type WidgetResizerCommitEvent = DecoratedMethodEvent<WidgetResizer, 'commit'>;
+* @eventName ~WidgetResizer#commit
+*/
+export type WidgetResizerCommitEvent = DecoratedMethodEvent<WidgetResizer, "commit">;
 /**
- * @eventName ~WidgetResizer#updateSize
- */
-export type WidgetResizerUpdateSizeEvent = DecoratedMethodEvent<WidgetResizer, 'updateSize'>;
+* @eventName ~WidgetResizer#updateSize
+*/
+export type WidgetResizerUpdateSizeEvent = DecoratedMethodEvent<WidgetResizer, "updateSize">;
 export {};