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

package/dist/view/observer/bubblingemittermixin.d.ts

@@ -1,166 +1,176 @@
 /**
- * @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 engine/view/observer/bubblingemittermixin
- */
-import { type ArrayOrItem, type Emitter, type BaseEvent, type CallbackOptions, type Constructor, type Mixed } from '@ckeditor/ckeditor5-utils';
-import { BubblingEventInfo } from './bubblingeventinfo.js';
-import { type ViewNode } from '../node.js';
+* @module engine/view/observer/bubblingemittermixin
+*/
+import { type ArrayOrItem, type Emitter, type BaseEvent, type CallbackOptions, type Constructor, type Mixed } from "@ckeditor/ckeditor5-utils";
+import { BubblingEventInfo } from "./bubblingeventinfo.js";
+import { type ViewNode } from "../node.js";
 /**
- * Bubbling emitter mixin for the view document as described in the {@link ~BubblingEmitter} interface.
- *
- * This function creates a class that inherits from the provided `base` and implements `Emitter` interface.
- * The base class must implement {@link module:utils/emittermixin~Emitter} interface.
- *
- * ```ts
- * class BaseClass extends EmitterMixin() {
- * 	// ...
- * }
- *
- * class MyClass extends BubblingEmitterMixin( BaseClass ) {
- * 	// This class derives from `BaseClass` and implements the `BubblingEmitter` interface.
- * }
- * ```
- */
-export declare function BubblingEmitterMixin<Base extends Constructor<Emitter>>(base: Base): Mixed<Base, BubblingEmitter>;
+* Constructor returned by {@link ~BubblingEmitterMixin}. Use it to name a mixin base class before extending it.
+*
+* ```ts
+* const MyBubblingEmitterBase: BubblingEmitterMixinConstructor<typeof BaseClass> = BubblingEmitterMixin( BaseClass );
+*
+* class MyBubblingEmitter extends MyBubblingEmitterBase {}
+* ```
+*/
+export type BubblingEmitterMixinConstructor<Base extends Constructor<Emitter>> = Mixed<Base, BubblingEmitter>;
 /**
- * Bubbling emitter for the view document.
- *
- * Bubbling emitter is triggering events in the context of specified {@link module:engine/view/element~ViewElement view element} name,
- * predefined `'$text'`, `'$root'`, `'$document'` and `'$capture'` contexts, and context matchers provided as a function.
- *
- * Before bubbling starts, listeners for `'$capture'` context are triggered. Then the bubbling starts from the deeper selection
- * position (by firing event on the `'$text'` context) and propagates the view document tree up to the `'$root'` and finally
- * the listeners at `'$document'` context are fired (this is the default context).
- *
- * Examples:
- *
- * ```ts
- * // Listeners registered in the context of the view element names:
- * this.listenTo( viewDocument, 'enter', ( evt, data ) => {
- * 	// ...
- * }, { context: 'blockquote' } );
- *
- * this.listenTo( viewDocument, 'enter', ( evt, data ) => {
- * 	// ...
- * }, { context: 'li' } );
- *
- * // Listeners registered in the context of the '$text' and '$root' nodes.
- * this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
- * 	// ...
- * }, { context: '$text', priority: 'high' } );
- *
- * this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
- * 	// ...
- * }, { context: '$root' } );
- *
- * // Listeners registered in the context of custom callback function.
- * this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
- * 	// ...
- * }, { context: isWidget } );
- *
- * this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
- * 	// ...
- * }, { context: isWidget, priority: 'high' } );
- * ```
- *
- * Example flow for selection in text:
- *
- * ```xml
- * <blockquote><p>Foo[]bar</p></blockquote>
- * ```
- *
- * Fired events on contexts:
- * 1. `'$capture'`
- * 2. `'$text'`
- * 3. `'p'`
- * 4. `'blockquote'`
- * 5. `'$root'`
- * 6. `'$document'`
- *
- * Example flow for selection on element (i.e., Widget):
- *
- * ```xml
- * <blockquote><p>Foo[<widget/>]bar</p></blockquote>
- * ```
- *
- * Fired events on contexts:
- * 1. `'$capture'`
- * 2. *widget* (custom matcher)
- * 3. `'p'`
- * 4. `'blockquote'`
- * 5. `'$root'`
- * 6. `'$document'`
- *
- * There could be multiple listeners registered for the same context and at different priority levels:
- *
- * ```html
- * <p>Foo[]bar</p>
- * ```
- *
- * 1. `'$capture'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- * 2. `'$text'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- * 3. `'p'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- * 4. `'$root'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- * 5. `'$document'` at priorities:
- *    1. `'highest'`
- *    2. `'high'`
- *    3. `'normal'`
- *    4. `'low'`
- *    5. `'lowest'`
- */
+* Bubbling emitter mixin for the view document as described in the {@link ~BubblingEmitter} interface.
+*
+* This function creates a class that inherits from the provided `base` and implements `Emitter` interface.
+* The base class must implement {@link module:utils/emittermixin~Emitter} interface.
+*
+* ```ts
+* class BaseClass extends EmitterMixin() {
+* 	// ...
+* }
+*
+* class MyClass extends BubblingEmitterMixin( BaseClass ) {
+* 	// This class derives from `BaseClass` and implements the `BubblingEmitter` interface.
+* }
+* ```
+*/
+export declare function BubblingEmitterMixin<Base extends Constructor<Emitter>>(base: Base): BubblingEmitterMixinConstructor<Base>;
+/**
+* Bubbling emitter for the view document.
+*
+* Bubbling emitter is triggering events in the context of specified {@link module:engine/view/element~ViewElement view element} name,
+* predefined `'$text'`, `'$root'`, `'$document'` and `'$capture'` contexts, and context matchers provided as a function.
+*
+* Before bubbling starts, listeners for `'$capture'` context are triggered. Then the bubbling starts from the deeper selection
+* position (by firing event on the `'$text'` context) and propagates the view document tree up to the `'$root'` and finally
+* the listeners at `'$document'` context are fired (this is the default context).
+*
+* Examples:
+*
+* ```ts
+* // Listeners registered in the context of the view element names:
+* this.listenTo( viewDocument, 'enter', ( evt, data ) => {
+* 	// ...
+* }, { context: 'blockquote' } );
+*
+* this.listenTo( viewDocument, 'enter', ( evt, data ) => {
+* 	// ...
+* }, { context: 'li' } );
+*
+* // Listeners registered in the context of the '$text' and '$root' nodes.
+* this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
+* 	// ...
+* }, { context: '$text', priority: 'high' } );
+*
+* this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
+* 	// ...
+* }, { context: '$root' } );
+*
+* // Listeners registered in the context of custom callback function.
+* this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
+* 	// ...
+* }, { context: isWidget } );
+*
+* this.listenTo( view.document, 'arrowKey', ( evt, data ) => {
+* 	// ...
+* }, { context: isWidget, priority: 'high' } );
+* ```
+*
+* Example flow for selection in text:
+*
+* ```xml
+* <blockquote><p>Foo[]bar</p></blockquote>
+* ```
+*
+* Fired events on contexts:
+* 1. `'$capture'`
+* 2. `'$text'`
+* 3. `'p'`
+* 4. `'blockquote'`
+* 5. `'$root'`
+* 6. `'$document'`
+*
+* Example flow for selection on element (i.e., Widget):
+*
+* ```xml
+* <blockquote><p>Foo[<widget/>]bar</p></blockquote>
+* ```
+*
+* Fired events on contexts:
+* 1. `'$capture'`
+* 2. *widget* (custom matcher)
+* 3. `'p'`
+* 4. `'blockquote'`
+* 5. `'$root'`
+* 6. `'$document'`
+*
+* There could be multiple listeners registered for the same context and at different priority levels:
+*
+* ```html
+* <p>Foo[]bar</p>
+* ```
+*
+* 1. `'$capture'` at priorities:
+*    1. `'highest'`
+*    2. `'high'`
+*    3. `'normal'`
+*    4. `'low'`
+*    5. `'lowest'`
+* 2. `'$text'` at priorities:
+*    1. `'highest'`
+*    2. `'high'`
+*    3. `'normal'`
+*    4. `'low'`
+*    5. `'lowest'`
+* 3. `'p'` at priorities:
+*    1. `'highest'`
+*    2. `'high'`
+*    3. `'normal'`
+*    4. `'low'`
+*    5. `'lowest'`
+* 4. `'$root'` at priorities:
+*    1. `'highest'`
+*    2. `'high'`
+*    3. `'normal'`
+*    4. `'low'`
+*    5. `'lowest'`
+* 5. `'$document'` at priorities:
+*    1. `'highest'`
+*    2. `'high'`
+*    3. `'normal'`
+*    4. `'low'`
+*    5. `'lowest'`
+*/
 export type BubblingEmitter = Emitter;
 /**
- * A context matcher function.
- *
- * Should return true for nodes that that match the custom context.
- */
+* A context matcher function.
+*
+* Should return true for nodes that that match the custom context.
+*/
 export type BubblingEventContextFunction = (node: ViewNode) => boolean;
 /**
- * Helper type that allows describing bubbling event. Extends `TEvent` so that:
- *
- * * the event is called with {@link module:engine/view/observer/bubblingeventinfo~BubblingEventInfo}`
- * instead of {@link module:utils/eventinfo~EventInfo}, and
- * * {@link ~BubblingCallbackOptions} can be specified as additional options.
- *
- * @typeParam TEvent The event description to extend.
- */
+* Helper type that allows describing bubbling event. Extends `TEvent` so that:
+*
+* * the event is called with {@link module:engine/view/observer/bubblingeventinfo~BubblingEventInfo}`
+* instead of {@link module:utils/eventinfo~EventInfo}, and
+* * {@link ~BubblingCallbackOptions} can be specified as additional options.
+*
+* @typeParam TEvent The event description to extend.
+*/
 export type BubblingEvent<TEvent extends BaseEvent> = TEvent & {
-    eventInfo: BubblingEventInfo<TEvent['name'], (TEvent extends {
-        return: infer TReturn;
-    } ? TReturn : unknown)>;
-    callbackOptions: BubblingCallbackOptions;
+	eventInfo: BubblingEventInfo<TEvent["name"], (TEvent extends {
+		return: infer TReturn;
+	} ? TReturn : unknown)>;
+	callbackOptions: BubblingCallbackOptions;
 };
 /**
- * Additional options for registering a callback.
- */
+* Additional options for registering a callback.
+*/
 export interface BubblingCallbackOptions extends CallbackOptions {
-    /**
-     * Specifies the context in which the event should be triggered to call the callback.
-     *
-     * @see ~BubblingEmitter
-     */
-    context?: ArrayOrItem<string | BubblingEventContextFunction>;
+	/**
+	* Specifies the context in which the event should be triggered to call the callback.
+	*
+	* @see ~BubblingEmitter
+	*/
+	context?: ArrayOrItem<string | BubblingEventContextFunction>;
 }

package/dist/view/observer/bubblingeventinfo.d.ts

@@ -1,47 +1,50 @@
 /**
- * @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 engine/view/observer/bubblingeventinfo
- */
-import { EventInfo } from '@ckeditor/ckeditor5-utils';
-import { type ViewDocument } from '../document.js';
-import { type ViewNode } from '../node.js';
-import { type ViewRange } from '../range.js';
+* @module engine/view/observer/bubblingeventinfo
+*/
+import { EventInfo } from "@ckeditor/ckeditor5-utils";
+import { type ViewDocument } from "../document.js";
+import { type ViewNode } from "../node.js";
+import { type ViewRange } from "../range.js";
 /**
- * The event object passed to bubbling event callbacks. It is used to provide information about the event as well as a tool to
- * manipulate it.
- */
-export declare class BubblingEventInfo<TName extends string = string, TReturn = unknown> extends EventInfo<TName, TReturn> {
-    /**
-     * The view range that the bubbling should start from.
-     */
-    readonly startRange: ViewRange;
-    /**
-     * The current event phase.
-     */
-    private _eventPhase;
-    /**
-     * The current bubbling target.
-     */
-    private _currentTarget;
-    /**
-     * @param source The emitter.
-     * @param name The event name.
-     * @param startRange The view range that the bubbling should start from.
-     */
-    constructor(source: object, name: TName, startRange: ViewRange);
-    /**
-     * The current event phase.
-     */
-    get eventPhase(): BubblingEventPhase;
-    /**
-     * The current bubbling target.
-     */
-    get currentTarget(): ViewDocument | ViewNode | null;
+* The event object passed to bubbling event callbacks. It is used to provide information about the event as well as a tool to
+* manipulate it.
+*/
+export declare class BubblingEventInfo<
+	TName extends string = string,
+	TReturn = unknown
+> extends EventInfo<TName, TReturn> {
+	/**
+	* The view range that the bubbling should start from.
+	*/
+	readonly startRange: ViewRange;
+	/**
+	* The current event phase.
+	*/
+	private _eventPhase;
+	/**
+	* The current bubbling target.
+	*/
+	private _currentTarget;
+	/**
+	* @param source The emitter.
+	* @param name The event name.
+	* @param startRange The view range that the bubbling should start from.
+	*/
+	constructor(source: object, name: TName, startRange: ViewRange);
+	/**
+	* The current event phase.
+	*/
+	get eventPhase(): BubblingEventPhase;
+	/**
+	* The current bubbling target.
+	*/
+	get currentTarget(): ViewDocument | ViewNode | null;
 }
 /**
- * The phase the event is in.
- */
-export type BubblingEventPhase = 'none' | 'capturing' | 'atTarget' | 'bubbling';
+* The phase the event is in.
+*/
+export type BubblingEventPhase = "none" | "capturing" | "atTarget" | "bubbling";

package/dist/view/observer/clickobserver.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 engine/view/observer/clickobserver
- */
-import { DomEventObserver } from './domeventobserver.js';
-import { type ViewDocumentDomEventData } from './domeventdata.js';
-import type { BubblingEvent } from './bubblingemittermixin.js';
+* @module engine/view/observer/clickobserver
+*/
+import { DomEventObserver } from "./domeventobserver.js";
+import { type ViewDocumentDomEventData } from "./domeventdata.js";
+import type { BubblingEvent } from "./bubblingemittermixin.js";
 /**
- * {@link module:engine/view/document~ViewDocument#event:click Click} event observer.
- *
- * Note that this observer is not available by default. To make it available it needs to be added to
- * {@link module:engine/view/view~EditingView view controller} by a {@link module:engine/view/view~EditingView#addObserver} method.
- */
-export declare class ClickObserver extends DomEventObserver<'click'> {
-    /**
-     * @inheritDoc
-     */
-    readonly domEventType: "click";
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent: MouseEvent): void;
+* {@link module:engine/view/document~ViewDocument#event:click Click} event observer.
+*
+* Note that this observer is not available by default. To make it available it needs to be added to
+* {@link module:engine/view/view~EditingView view controller} by a {@link module:engine/view/view~EditingView#addObserver} method.
+*/
+export declare class ClickObserver extends DomEventObserver<"click"> {
+	/**
+	* @inheritDoc
+	*/
+	readonly domEventType = "click";
+	/**
+	* @inheritDoc
+	*/
+	onDomEvent(domEvent: MouseEvent): void;
 }
 /**
- * Fired when one of the editables has been clicked.
- *
- * Introduced by {@link module:engine/view/observer/clickobserver~ClickObserver}.
- *
- * Note that this event is not available by default. To make it available
- * {@link module:engine/view/observer/clickobserver~ClickObserver} needs to be added
- * to {@link module:engine/view/view~EditingView} by a {@link module:engine/view/view~EditingView#addObserver} method.
- *
- * @see module:engine/view/observer/clickobserver~ClickObserver
- * @eventName module:engine/view/document~ViewDocument#click
- * @param data Event data.
- */
+* Fired when one of the editables has been clicked.
+*
+* Introduced by {@link module:engine/view/observer/clickobserver~ClickObserver}.
+*
+* Note that this event is not available by default. To make it available
+* {@link module:engine/view/observer/clickobserver~ClickObserver} needs to be added
+* to {@link module:engine/view/view~EditingView} by a {@link module:engine/view/view~EditingView#addObserver} method.
+*
+* @see module:engine/view/observer/clickobserver~ClickObserver
+* @eventName module:engine/view/document~ViewDocument#click
+* @param data Event data.
+*/
 export type ViewDocumentClickEvent = BubblingEvent<{
-    name: 'click';
-    args: [data: ViewDocumentDomEventData<MouseEvent>];
+	name: "click";
+	args: [data: ViewDocumentDomEventData<MouseEvent>];
 }>;