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

package/dist/badge/badge.d.ts

@@ -1,129 +1,127 @@
 /**
- * @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 ui/badge/badge
- */
-import type { Editor } from '@ckeditor/ckeditor5-core';
-import { type View } from '../view.js';
-declare const Badge_base: {
-    new (): import("@ckeditor/ckeditor5-utils").DomEmitter;
-    prototype: import("@ckeditor/ckeditor5-utils").DomEmitter;
-};
+* @module ui/badge/badge
+*/
+import type { Editor } from "@ckeditor/ckeditor5-core";
+import { type DomEmitterMixinConstructor } from "@ckeditor/ckeditor5-utils";
+import { type View } from "../view.js";
+declare const BadgeBase: DomEmitterMixinConstructor;
 /**
- * A helper that enables the badge feature in the editor and renders a custom view next to the bottom of the editable element
- * (editor root, source editing area, etc.) when the editor is focused.
- *
- * @private
- */
-export declare abstract class Badge extends /* #__PURE__ */ Badge_base {
-    /**
-     * Editor instance the helper was created for.
-     */
-    protected readonly editor: Editor;
-    /**
-     * A reference to the balloon panel hosting and positioning the badge content.
-     */
-    private _balloonView;
-    /**
-     * A throttled version of the {@link #_showBalloon} method meant for frequent use to avoid performance loss.
-     */
-    private _showBalloonThrottled;
-    /**
-     * A reference to the last editable element (root, source editing area, etc.) focused by the user.
-     * Since the focus can move to other focusable elements in the UI, this reference allows positioning the balloon over the
-     * right element whether the user is typing or using the UI.
-     */
-    private _lastFocusedEditableElement;
-    /**
-     * An additional CSS class added to the `BalloonView`.
-     */
-    private readonly _balloonClass;
-    /**
-     * Creates a badge for a given editor. The feature is initialized on Editor#ready
-     * event.
-     */
-    protected constructor(editor: Editor, options?: {
-        balloonClass?: string;
-    });
-    /**
-     * Destroys the badge along with its view.
-     */
-    destroy(): void;
-    /**
-     * Enables badge label once the editor (ui) is ready.
-     */
-    protected _handleEditorReady(): void;
-    /**
-     * Returns normalized configuration for the badge.
-     */
-    protected _getNormalizedConfig(): BadgeConfig;
-    /**
-     * Creates the badge content.
-     */
-    protected abstract _createBadgeContent(): View<HTMLElement>;
-    /**
-     * Enables the badge feature.
-     */
-    protected abstract _isEnabled(): boolean;
-    /**
-     * Attempts to display the balloon with the badge view.
-     */
-    private _showBalloon;
-    /**
-     * Hides the badge balloon if already visible.
-     */
-    private _hideBalloon;
-    /**
-     * Creates an instance of the {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView balloon panel}
-     * with the badge view inside ready for positioning.
-     */
-    private _createBalloonView;
-    /**
-     * Returns the options for attaching the balloon to the focused editable element.
-     */
-    private _getBalloonAttachOptions;
-    /**
-     * Updates the {@link #_lastFocusedEditableElement} based on the state of the global focus tracker.
-     */
-    private _updateLastFocusedEditableElement;
+* A helper that enables the badge feature in the editor and renders a custom view next to the bottom of the editable element
+* (editor root, source editing area, etc.) when the editor is focused.
+*
+* @private
+*/
+export declare abstract class Badge extends BadgeBase {
+	/**
+	* Editor instance the helper was created for.
+	*/
+	protected readonly editor: Editor;
+	/**
+	* A reference to the balloon panel hosting and positioning the badge content.
+	*/
+	private _balloonView;
+	/**
+	* A throttled version of the {@link #_showBalloon} method meant for frequent use to avoid performance loss.
+	*/
+	private _showBalloonThrottled;
+	/**
+	* A reference to the last editable element (root, source editing area, etc.) focused by the user.
+	* Since the focus can move to other focusable elements in the UI, this reference allows positioning the balloon over the
+	* right element whether the user is typing or using the UI.
+	*/
+	private _lastFocusedEditableElement;
+	/**
+	* An additional CSS class added to the `BalloonView`.
+	*/
+	private readonly _balloonClass;
+	/**
+	* Creates a badge for a given editor. The feature is initialized on Editor#ready
+	* event.
+	*/
+	protected constructor(editor: Editor, options?: {
+		balloonClass?: string;
+	});
+	/**
+	* Destroys the badge along with its view.
+	*/
+	destroy(): void;
+	/**
+	* Enables badge label once the editor (ui) is ready.
+	*/
+	protected _handleEditorReady(): void;
+	/**
+	* Returns normalized configuration for the badge.
+	*/
+	protected _getNormalizedConfig(): BadgeConfig;
+	/**
+	* Creates the badge content.
+	*/
+	protected abstract _createBadgeContent(): View<HTMLElement>;
+	/**
+	* Enables the badge feature.
+	*/
+	protected abstract _isEnabled(): boolean;
+	/**
+	* Attempts to display the balloon with the badge view.
+	*/
+	private _showBalloon;
+	/**
+	* Hides the badge balloon if already visible.
+	*/
+	private _hideBalloon;
+	/**
+	* Creates an instance of the {@link module:ui/panel/balloon/balloonpanelview~BalloonPanelView balloon panel}
+	* with the badge view inside ready for positioning.
+	*/
+	private _createBalloonView;
+	/**
+	* Returns the options for attaching the balloon to the focused editable element.
+	*/
+	private _getBalloonAttachOptions;
+	/**
+	* Updates the {@link #_lastFocusedEditableElement} based on the state of the global focus tracker.
+	*/
+	private _updateLastFocusedEditableElement;
 }
 /**
- * The badge configuration options.
- **/
+* The badge configuration options.
+**/
 export interface BadgeConfig {
-    /**
-     * The position of the badge.
-     *
-     * * When `'inside'`, the badge will be displayed within the boundaries of the editing area.
-     * * When `'border'`, the basge will be displayed over the bottom border of the editing area.
-     *
-     * @default 'border'
-     */
-    position: 'inside' | 'border';
-    /**
-     * Allows choosing the side of the editing area where the badge will be displayed.
-     *
-     * **Note:** If {@link module:core/editor/editorconfig~EditorConfig#language `config.language`} is set to an RTL (right-to-left)
-     * language, the side switches to `'left'` by default.
-     *
-     * @default 'right'
-     */
-    side: 'left' | 'right';
-    /**
-     * The vertical distance the badge can be moved away from its default position.
-     *
-     * **Note:** If `position` is `'border'`, the offset is measured from the (vertical) center of the badge.
-     *
-     * @default 5
-     */
-    verticalOffset: number;
-    /**
-     * The horizontal distance between the side of the editing root and the nearest side of the badge.
-     *
-     * @default 5
-     */
-    horizontalOffset: number;
+	/**
+	* The position of the badge.
+	*
+	* * When `'inside'`, the badge will be displayed within the boundaries of the editing area.
+	* * When `'border'`, the basge will be displayed over the bottom border of the editing area.
+	*
+	* @default 'border'
+	*/
+	position: "inside" | "border";
+	/**
+	* Allows choosing the side of the editing area where the badge will be displayed.
+	*
+	* **Note:** If {@link module:core/editor/editorconfig~EditorConfig#language `config.language`} is set to an RTL (right-to-left)
+	* language, the side switches to `'left'` by default.
+	*
+	* @default 'right'
+	*/
+	side: "left" | "right";
+	/**
+	* The vertical distance the badge can be moved away from its default position.
+	*
+	* **Note:** If `position` is `'border'`, the offset is measured from the (vertical) center of the badge.
+	*
+	* @default 5
+	*/
+	verticalOffset: number;
+	/**
+	* The horizontal distance between the side of the editing root and the nearest side of the badge.
+	*
+	* @default 5
+	*/
+	horizontalOffset: number;
 }
 export {};

package/dist/bindings/addkeyboardhandlingforgrid.d.ts

@@ -1,27 +1,27 @@
 /**
- * @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 ui/bindings/addkeyboardhandlingforgrid
- */
-import type { FocusTracker, KeystrokeHandler } from '@ckeditor/ckeditor5-utils';
-import { type ViewCollection } from '../viewcollection.js';
+* @module ui/bindings/addkeyboardhandlingforgrid
+*/
+import type { FocusTracker, KeystrokeHandler } from "@ckeditor/ckeditor5-utils";
+import { type ViewCollection } from "../viewcollection.js";
 /**
- * A helper that adds a keyboard navigation support (arrow up/down/left/right) for grids.
- *
- * @param options Configuration options.
- * @param options.keystrokeHandler Keystroke handler to register navigation with arrow keys.
- * @param options.focusTracker A focus tracker for grid elements.
- * @param options.gridItems A collection of grid items.
- * @param options.numberOfColumns Number of columns in the grid. Can be specified as a function that returns
- * the number (e.g. for responsive grids).
- * @param options.uiLanguageDirection String of ui language direction.
- */
+* A helper that adds a keyboard navigation support (arrow up/down/left/right) for grids.
+*
+* @param options Configuration options.
+* @param options.keystrokeHandler Keystroke handler to register navigation with arrow keys.
+* @param options.focusTracker A focus tracker for grid elements.
+* @param options.gridItems A collection of grid items.
+* @param options.numberOfColumns Number of columns in the grid. Can be specified as a function that returns
+* the number (e.g. for responsive grids).
+* @param options.uiLanguageDirection String of ui language direction.
+*/
 export declare function addKeyboardHandlingForGrid({ keystrokeHandler, focusTracker, gridItems, numberOfColumns, uiLanguageDirection }: {
-    keystrokeHandler: KeystrokeHandler;
-    focusTracker: FocusTracker;
-    gridItems: ViewCollection;
-    numberOfColumns: number | (() => number);
-    uiLanguageDirection?: string;
+	keystrokeHandler: KeystrokeHandler;
+	focusTracker: FocusTracker;
+	gridItems: ViewCollection;
+	numberOfColumns: number | (() => number);
+	uiLanguageDirection?: string;
 }): void;

package/dist/bindings/clickoutsidehandler.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 ui/bindings/clickoutsidehandler
- */
-import type { CallbackOptions, DomEmitter } from '@ckeditor/ckeditor5-utils';
+* @module ui/bindings/clickoutsidehandler
+*/
+import type { CallbackOptions, DomEmitter } from "@ckeditor/ckeditor5-utils";
 /**
- * Handles clicking **outside** of a specified set of elements, then fires an action.
- *
- * **Note**: Actually, the action is executed upon `mousedown`, not `click`. It prevents
- * certain issues when the user keeps holding the mouse button and the UI cannot react
- * properly.
- *
- * @param options Configuration options.
- * @param options.emitter The emitter to which this behavior should be added.
- * @param options.activator Function returning a `Boolean`, to determine whether the handler is active.
- * @param options.contextElements Array of HTML elements or a callback returning an array of HTML elements
- * that determine the scope of the handler. Clicking any of them or their descendants will **not** fire the callback.
- * @param options.callback An action executed by the handler.
- * @param options.listenerOptions Additional options for the listener (like priority).
- */
+* Handles clicking **outside** of a specified set of elements, then fires an action.
+*
+* **Note**: Actually, the action is executed upon `mousedown`, not `click`. It prevents
+* certain issues when the user keeps holding the mouse button and the UI cannot react
+* properly.
+*
+* @param options Configuration options.
+* @param options.emitter The emitter to which this behavior should be added.
+* @param options.activator Function returning a `Boolean`, to determine whether the handler is active.
+* @param options.contextElements Array of HTML elements or a callback returning an array of HTML elements
+* that determine the scope of the handler. Clicking any of them or their descendants will **not** fire the callback.
+* @param options.callback An action executed by the handler.
+* @param options.listenerOptions Additional options for the listener (like priority).
+*/
 export declare function clickOutsideHandler({ emitter, activator, callback, contextElements, listenerOptions }: {
-    emitter: DomEmitter;
-    activator: () => boolean;
-    contextElements: Array<Element> | (() => Array<Element>);
-    callback: () => void;
-    listenerOptions?: CallbackOptions;
+	emitter: DomEmitter;
+	activator: () => boolean;
+	contextElements: Array<Element> | (() => Array<Element>);
+	callback: () => void;
+	listenerOptions?: CallbackOptions;
 }): void;

package/dist/bindings/csstransitiondisablermixin.d.ts

@@ -1,41 +1,52 @@
 /**
- * @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 ui/bindings/csstransitiondisablermixin
- */
-import type { Constructor, Mixed } from '@ckeditor/ckeditor5-utils';
-import { type View } from '../view.js';
+* @module ui/bindings/csstransitiondisablermixin
+*/
+import type { Constructor, Mixed } from "@ckeditor/ckeditor5-utils";
+import { type View } from "../view.js";
 /**
- * A mixin that brings the possibility to temporarily disable CSS transitions using
- * {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
- * when the view is first displayed but they should work normal in other cases.
- *
- * The methods to control the CSS transitions are:
- * * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
- * {@link module:ui/view~View#element view element}.
- * * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
- * {@link module:ui/view~View#element view element}.
- *
- * The usage comes down to:
- *
- * ```ts
- * const MyViewWithCssTransitionDisabler = CssTransitionDisablerMixin( MyView );
- * const view = new MyViewWithCssTransitionDisabler();
- *
- * // ...
- *
- * view.disableCssTransitions();
- * view.show();
- * view.enableCssTransitions();
- * ```
- *
- * @param view View instance that should get this functionality.
- */
-export declare function CssTransitionDisablerMixin<Base extends Constructor<View>>(view: Base): Mixed<Base, ViewWithCssTransitionDisabler>;
+* Constructor returned by {@link ~CssTransitionDisablerMixin}. Use it to name a mixin base class before extending it.
+*
+* ```ts
+* const MyCssTransitionDisablerBase: CssTransitionDisablerMixinConstructor<typeof BaseClass> =
+* 	CssTransitionDisablerMixin( BaseClass );
+*
+* class MyCssTransitionDisabler extends MyCssTransitionDisablerBase {}
+* ```
+*/
+export type CssTransitionDisablerMixinConstructor<Base extends Constructor<View>> = Mixed<Base, ViewWithCssTransitionDisabler>;
+/**
+* A mixin that brings the possibility to temporarily disable CSS transitions using
+* {@link module:ui/view~View} methods. It is helpful when, for instance, the transitions should not happen
+* when the view is first displayed but they should work normal in other cases.
+*
+* The methods to control the CSS transitions are:
+* * `disableCssTransitions()` – Adds the `.ck-transitions-disabled` class to the
+* {@link module:ui/view~View#element view element}.
+* * `enableCssTransitions()` – Removes the `.ck-transitions-disabled` class from the
+* {@link module:ui/view~View#element view element}.
+*
+* The usage comes down to:
+*
+* ```ts
+* const MyViewWithCssTransitionDisabler = CssTransitionDisablerMixin( MyView );
+* const view = new MyViewWithCssTransitionDisabler();
+*
+* // ...
+*
+* view.disableCssTransitions();
+* view.show();
+* view.enableCssTransitions();
+* ```
+*
+* @param view View instance that should get this functionality.
+*/
+export declare function CssTransitionDisablerMixin<Base extends Constructor<View>>(view: Base): CssTransitionDisablerMixinConstructor<Base>;
 export declare class ViewWithCssTransitionDisabler extends View {
-    disableCssTransitions(): void;
-    enableCssTransitions(): void;
-    protected initializeCssTransitionDisablerMixin(): void;
+	disableCssTransitions(): void;
+	enableCssTransitions(): void;
+	protected initializeCssTransitionDisablerMixin(): void;
 }

package/dist/bindings/draggableviewmixin.d.ts

@@ -1,46 +1,54 @@
 /**
- * @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 ui/bindings/draggableviewmixin
- */
-import { type View } from '../view.js';
-import { type Constructor, type Mixed } from '@ckeditor/ckeditor5-utils';
+* @module ui/bindings/draggableviewmixin
+*/
+import { type View } from "../view.js";
+import { type Constructor, type Mixed } from "@ckeditor/ckeditor5-utils";
 /**
- * A mixin that brings the possibility to observe dragging of the view element.
- * The view has to implement the {@link ~DraggableView} interface to use it:
- *
- * ```js
- * export class MyDraggableView extends DraggableViewMixin( View ) implements DraggableView {
- * 		// ...
- * }
- * ```
- *
- * Creating a class extending it attaches a set of mouse and touch listeners allowing to observe dragging of the view element:
- * * `mousedown` and `touchstart` on the view element - starting the dragging.
- * * `mousemove` and `touchmove` on the document - updating the view coordinates.
- * * `mouseup` and `touchend` on the document - stopping the dragging.
- *
- * The mixin itself does not provide a visual feedback (that is, the dragged element does not change its position) -
- * it is up to the developer to implement it.
- */
-export declare function DraggableViewMixin<Base extends Constructor<View>>(view: Base): Mixed<Base, DraggableView>;
+* Constructor returned by {@link ~DraggableViewMixin}. Use it to name a mixin base class before extending it.
+*
+* ```ts
+* const MyDraggableViewBase: DraggableViewMixinConstructor<typeof BaseClass> = DraggableViewMixin( BaseClass );
+*
+* class MyDraggableView extends MyDraggableViewBase {}
+* ```
+*/
+export type DraggableViewMixinConstructor<Base extends Constructor<View>> = Mixed<Base, DraggableView>;
 /**
- * An interface that should be implemented by views that want to be draggable.
- */
+* A mixin that brings the possibility to observe dragging of the view element.
+* The view has to implement the {@link ~DraggableView} interface to use it:
+*
+* ```js
+* export class MyDraggableView extends DraggableViewMixin( View ) implements DraggableView {
+* 		// ...
+* }
+* ```
+*
+* Creating a class extending it attaches a set of mouse and touch listeners allowing to observe dragging of the view element:
+* * `mousedown` and `touchstart` on the view element - starting the dragging.
+* * `mousemove` and `touchmove` on the document - updating the view coordinates.
+* * `mouseup` and `touchend` on the document - stopping the dragging.
+*
+* The mixin itself does not provide a visual feedback (that is, the dragged element does not change its position) -
+* it is up to the developer to implement it.
+*/
+export declare function DraggableViewMixin<Base extends Constructor<View>>(view: Base): DraggableViewMixinConstructor<Base>;
+/**
+* An interface that should be implemented by views that want to be draggable.
+*/
 export interface DraggableView extends View {
-    get dragHandleElement(): HTMLElement | null;
+	get dragHandleElement(): HTMLElement | null;
 }
 /**
- * An event data object for the {@link ~DraggableView} `drag` event. Fired when the view is dragged.
- */
+* An event data object for the {@link ~DraggableView} `drag` event. Fired when the view is dragged.
+*/
 export type DraggableViewDragEvent = {
-    name: 'drag';
-    args: [
-        {
-            deltaX: number;
-            deltaY: number;
-        }
-    ];
+	name: "drag";
+	args: [{
+		deltaX: number;
+		deltaY: number;
+	}];
 };

package/dist/bindings/preventdefault.d.ts

@@ -1,34 +1,34 @@
 /**
- * @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 ui/bindings/preventdefault
- */
-import type { ListenerBinding } from '../template.js';
-import { type View } from '../view.js';
+* @module ui/bindings/preventdefault
+*/
+import type { ListenerBinding } from "../template.js";
+import { type View } from "../view.js";
 /**
- * A helper which executes a native `Event.preventDefault()` if the target of an event equals the
- * {@link module:ui/view~View#element element of the view}. It shortens the definition of a
- * {@link module:ui/view~View#template template}.
- *
- * ```ts
- * // In a class extending View.
- * import { preventDefault } from '@ckeditor/ckeditor5-ui/src/bindings/preventdefault';
- *
- * // ...
- *
- * this.setTemplate( {
- * 	tag: 'div',
- *
- * 	on: {
- * 		// Prevent the default mousedown action on this view.
- * 		mousedown: preventDefault( this )
- * 	}
- * } );
- * ```
- *
- * @param view View instance that defines the template.
- * @internal
- */
+* A helper which executes a native `Event.preventDefault()` if the target of an event equals the
+* {@link module:ui/view~View#element element of the view}. It shortens the definition of a
+* {@link module:ui/view~View#template template}.
+*
+* ```ts
+* // In a class extending View.
+* import { preventDefault } from '@ckeditor/ckeditor5-ui/src/bindings/preventdefault';
+*
+* // ...
+*
+* this.setTemplate( {
+* 	tag: 'div',
+*
+* 	on: {
+* 		// Prevent the default mousedown action on this view.
+* 		mousedown: preventDefault( this )
+* 	}
+* } );
+* ```
+*
+* @param view View instance that defines the template.
+* @internal
+*/
 export declare function preventDefault(view: View): ListenerBinding;