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

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

@@ -1,115 +1,115 @@
 /**
- * @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/mutationobserver
- */
-import { Observer } from './observer.js';
-import { type ViewDomConverter } from '../domconverter.js';
-import { type EditingView } from '../view.js';
-import { type ViewNode } from '../node.js';
-import type { ViewDocumentChangeType } from '../document.js';
+* @module engine/view/observer/mutationobserver
+*/
+import { Observer } from "./observer.js";
+import { type ViewDomConverter } from "../domconverter.js";
+import { type EditingView } from "../view.js";
+import { type ViewNode } from "../node.js";
+import type { ViewDocumentChangeType } from "../document.js";
 /**
- * Mutation observer's role is to watch for any DOM changes inside the editor that weren't
- * done by the editor's {@link module:engine/view/renderer~ViewRenderer} itself and reverting these changes.
- *
- * It does this by observing all mutations in the DOM, marking related view elements as changed and calling
- * {@link module:engine/view/renderer~ViewRenderer#render}. Because all mutated nodes are marked as
- * "to be rendered" and the {@link module:engine/view/renderer~ViewRenderer#render `render()`} method is called,
- * all changes are reverted in the DOM (the DOM is synced with the editor's view structure).
- *
- * Note that this observer is attached by the {@link module:engine/view/view~EditingView} and is available by default.
- */
+* Mutation observer's role is to watch for any DOM changes inside the editor that weren't
+* done by the editor's {@link module:engine/view/renderer~ViewRenderer} itself and reverting these changes.
+*
+* It does this by observing all mutations in the DOM, marking related view elements as changed and calling
+* {@link module:engine/view/renderer~ViewRenderer#render}. Because all mutated nodes are marked as
+* "to be rendered" and the {@link module:engine/view/renderer~ViewRenderer#render `render()`} method is called,
+* all changes are reverted in the DOM (the DOM is synced with the editor's view structure).
+*
+* Note that this observer is attached by the {@link module:engine/view/view~EditingView} and is available by default.
+*/
 export declare class MutationObserver extends Observer {
-    /**
-     * Reference to the {@link module:engine/view/view~EditingView#domConverter}.
-     */
-    readonly domConverter: ViewDomConverter;
-    /**
-     * Native mutation observer config.
-     */
-    private readonly _config;
-    /**
-     * Observed DOM elements.
-     */
-    private readonly _domElements;
-    /**
-     * Native mutation observer.
-     */
-    private _mutationObserver;
-    /**
-     * @inheritDoc
-     */
-    constructor(view: EditingView);
-    /**
-     * Synchronously handles mutations and empties the queue.
-     */
-    flush(): void;
-    /**
-     * @inheritDoc
-     */
-    observe(domElement: HTMLElement): void;
-    /**
-     * @inheritDoc
-     */
-    stopObserving(domElement: HTMLElement): void;
-    /**
-     * @inheritDoc
-     */
-    enable(): void;
-    /**
-     * @inheritDoc
-     */
-    disable(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
-    /**
-     * Handles mutations. Mark view elements to sync and call render.
-     *
-     * @param domMutations Array of native mutations.
-     */
-    private _onMutations;
-    /**
-     * Checks if mutation was generated by the browser inserting bogus br on the end of the block element.
-     * Such mutations are generated while pressing space or performing native spellchecker correction
-     * on the end of the block element in Firefox browser.
-     *
-     * @param mutation Native mutation object.
-     */
-    private _isBogusBrMutation;
+	/**
+	* Reference to the {@link module:engine/view/view~EditingView#domConverter}.
+	*/
+	readonly domConverter: ViewDomConverter;
+	/**
+	* Native mutation observer config.
+	*/
+	private readonly _config;
+	/**
+	* Observed DOM elements.
+	*/
+	private readonly _domElements;
+	/**
+	* Native mutation observer.
+	*/
+	private _mutationObserver;
+	/**
+	* @inheritDoc
+	*/
+	constructor(view: EditingView);
+	/**
+	* Synchronously handles mutations and empties the queue.
+	*/
+	flush(): void;
+	/**
+	* @inheritDoc
+	*/
+	observe(domElement: HTMLElement): void;
+	/**
+	* @inheritDoc
+	*/
+	override stopObserving(domElement: HTMLElement): void;
+	/**
+	* @inheritDoc
+	*/
+	override enable(): void;
+	/**
+	* @inheritDoc
+	*/
+	override disable(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
+	/**
+	* Handles mutations. Mark view elements to sync and call render.
+	*
+	* @param domMutations Array of native mutations.
+	*/
+	private _onMutations;
+	/**
+	* Checks if mutation was generated by the browser inserting bogus br on the end of the block element.
+	* Such mutations are generated while pressing space or performing native spellchecker correction
+	* on the end of the block element in Firefox browser.
+	*
+	* @param mutation Native mutation object.
+	*/
+	private _isBogusBrMutation;
 }
 /**
- * Event fired on DOM mutations detected.
- *
- * This event is introduced by {@link module:engine/view/observer/mutationobserver~MutationObserver} and available
- * by default in all editor instances (attached by {@link module:engine/view/view~EditingView}).
- *
- * @eventName module:engine/view/document~ViewDocument#mutations
- * @param data Event data containing detailed information about the event.
- */
+* Event fired on DOM mutations detected.
+*
+* This event is introduced by {@link module:engine/view/observer/mutationobserver~MutationObserver} and available
+* by default in all editor instances (attached by {@link module:engine/view/view~EditingView}).
+*
+* @eventName module:engine/view/document~ViewDocument#mutations
+* @param data Event data containing detailed information about the event.
+*/
 export type ViewDocumentMutationsEvent = {
-    name: 'mutations';
-    args: [data: ViewDocumentMutationEventData];
+	name: "mutations";
+	args: [data: ViewDocumentMutationEventData];
 };
 /**
- * The value of {@link ~ViewDocumentMutationsEvent}.
- */
+* The value of {@link ~ViewDocumentMutationsEvent}.
+*/
 export type ViewDocumentMutationEventData = {
-    mutations: Array<ObserverMutationData>;
+	mutations: Array<ObserverMutationData>;
 };
 /**
- * A single entry in {@link ~ViewDocumentMutationEventData} mutations array.
- */
+* A single entry in {@link ~ViewDocumentMutationEventData} mutations array.
+*/
 export type ObserverMutationData = {
-    /**
-     * Type of mutation detected.
-     */
-    type: ViewDocumentChangeType;
-    /**
-     * The view node related to the detected mutation.
-     */
-    node: ViewNode;
+	/**
+	* Type of mutation detected.
+	*/
+	type: ViewDocumentChangeType;
+	/**
+	* The view node related to the detected mutation.
+	*/
+	node: ViewNode;
 };

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

@@ -1,89 +1,90 @@
 /**
- * @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 ViewDocument } from '../document.js';
-import { type EditingView } from '../view.js';
-declare const Observer_base: {
-    new (): import("@ckeditor/ckeditor5-utils").DomEmitter;
-    prototype: import("@ckeditor/ckeditor5-utils").DomEmitter;
-};
+* @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
+*/
 /**
- * Abstract base observer class. Observers are classes which listen to DOM events, do the preliminary
- * processing and fire events on the {@link module:engine/view/document~ViewDocument} objects.
- * Observers can also add features to the view, for instance by updating its status or marking elements
- * which need a refresh on DOM events.
- */
-export declare abstract class Observer extends /* #__PURE__ */ Observer_base {
-    /**
-     * An instance of the view controller.
-     */
-    readonly view: EditingView;
-    /**
-     * A reference to the {@link module:engine/view/document~ViewDocument} object.
-     */
-    readonly document: ViewDocument;
-    /**
-     * The state of the observer. If it is disabled, no events will be fired.
-     */
-    private _isEnabled;
-    /**
-     * Creates an instance of the observer.
-     */
-    constructor(view: EditingView);
-    /**
-     * The state of the observer. If it is disabled, no events will be fired.
-     */
-    get isEnabled(): boolean;
-    /**
-     * Enables the observer. This method is called when the observer is registered to the
-     * {@link module:engine/view/view~EditingView} and after {@link module:engine/view/view~EditingView#forceRender rendering}
-     * (all observers are {@link #disable disabled} before rendering).
-     *
-     * A typical use case for disabling observers is that mutation observers need to be disabled for the rendering.
-     * However, a child class may not need to be disabled, so it can implement an empty method.
-     *
-     * @see module:engine/view/observer/observer~Observer#disable
-     */
-    enable(): void;
-    /**
-     * Disables the observer. This method is called before
-     * {@link module:engine/view/view~EditingView#forceRender rendering} to prevent firing events during rendering.
-     *
-     * @see module:engine/view/observer/observer~Observer#enable
-     */
-    disable(): void;
-    /**
-     * Disables and destroys the observer, among others removes event listeners created by the observer.
-     */
-    destroy(): void;
-    /**
-     * Checks whether a given DOM event should be ignored (should not be turned into a synthetic view document event).
-     *
-     * Currently, an event will be ignored only if its target or any of its ancestors has the `data-cke-ignore-events` attribute.
-     * This attribute can be used inside the structures generated by
-     * {@link module:engine/view/downcastwriter~ViewDowncastWriter#createUIElement `ViewDowncastWriter#createUIElement()`} to ignore events
-     * fired within a UI that should be excluded from CKEditor 5's realms.
-     *
-     * @param domTarget The DOM event target to check (usually an element, sometimes a text node and
-     * potentially sometimes a document, too).
-     * @returns Whether this event should be ignored by the observer.
-     */
-    checkShouldIgnoreEventFromTarget(domTarget: Node | null): boolean;
-    /**
-     * Starts observing given DOM element.
-     *
-     * @param domElement DOM element to observe.
-     * @param name The name of the related root element.
-     */
-    abstract observe(domElement: HTMLElement, name: string): void;
-    /**
-     * Stops observing given DOM element.
-     */
-    abstract stopObserving(domElement: HTMLElement): void;
+* @module engine/view/observer/observer
+*/
+import { type DomEmitterMixinConstructor } from "@ckeditor/ckeditor5-utils";
+import { type ViewDocument } from "../document.js";
+import { type EditingView } from "../view.js";
+declare const ObserverBase: DomEmitterMixinConstructor;
+/**
+* Abstract base observer class. Observers are classes which listen to DOM events, do the preliminary
+* processing and fire events on the {@link module:engine/view/document~ViewDocument} objects.
+* Observers can also add features to the view, for instance by updating its status or marking elements
+* which need a refresh on DOM events.
+*/
+export declare abstract class Observer extends ObserverBase {
+	/**
+	* An instance of the view controller.
+	*/
+	readonly view: EditingView;
+	/**
+	* A reference to the {@link module:engine/view/document~ViewDocument} object.
+	*/
+	readonly document: ViewDocument;
+	/**
+	* The state of the observer. If it is disabled, no events will be fired.
+	*/
+	private _isEnabled;
+	/**
+	* Creates an instance of the observer.
+	*/
+	constructor(view: EditingView);
+	/**
+	* The state of the observer. If it is disabled, no events will be fired.
+	*/
+	get isEnabled(): boolean;
+	/**
+	* Enables the observer. This method is called when the observer is registered to the
+	* {@link module:engine/view/view~EditingView} and after {@link module:engine/view/view~EditingView#forceRender rendering}
+	* (all observers are {@link #disable disabled} before rendering).
+	*
+	* A typical use case for disabling observers is that mutation observers need to be disabled for the rendering.
+	* However, a child class may not need to be disabled, so it can implement an empty method.
+	*
+	* @see module:engine/view/observer/observer~Observer#disable
+	*/
+	enable(): void;
+	/**
+	* Disables the observer. This method is called before
+	* {@link module:engine/view/view~EditingView#forceRender rendering} to prevent firing events during rendering.
+	*
+	* @see module:engine/view/observer/observer~Observer#enable
+	*/
+	disable(): void;
+	/**
+	* Disables and destroys the observer, among others removes event listeners created by the observer.
+	*/
+	destroy(): void;
+	/**
+	* Checks whether a given DOM event should be ignored (should not be turned into a synthetic view document event).
+	*
+	* Currently, an event will be ignored only if its target or any of its ancestors has the `data-cke-ignore-events` attribute.
+	* This attribute can be used inside the structures generated by
+	* {@link module:engine/view/downcastwriter~ViewDowncastWriter#createUIElement `ViewDowncastWriter#createUIElement()`} to ignore events
+	* fired within a UI that should be excluded from CKEditor 5's realms.
+	*
+	* @param domTarget The DOM event target to check (usually an element, sometimes a text node and
+	* potentially sometimes a document, too).
+	* @returns Whether this event should be ignored by the observer.
+	*/
+	checkShouldIgnoreEventFromTarget(domTarget: Node | null): boolean;
+	/**
+	* Starts observing given DOM element.
+	*
+	* @param domElement DOM element to observe.
+	* @param name The name of the related root element.
+	*/
+	abstract observe(domElement: HTMLElement, name: string): void;
+	/**
+	* Stops observing given DOM element.
+	*/
+	abstract stopObserving(domElement: HTMLElement): void;
 }
 /**
- * The constructor of {@link ~Observer} subclass.
- */
+* The constructor of {@link ~Observer} subclass.
+*/
 export type ObserverConstructor = new (view: EditingView) => Observer;
 export {};

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

@@ -1,76 +1,76 @@
 /**
- * @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/pointerobserver
- */
-import { DomEventObserver } from './domeventobserver.js';
-import { type ViewDocumentDomEventData } from './domeventdata.js';
+* @module engine/view/observer/pointerobserver
+*/
+import { DomEventObserver } from "./domeventobserver.js";
+import { type ViewDocumentDomEventData } from "./domeventdata.js";
 /**
- * Pointer events 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} by {@link module:engine/view/view~EditingView#addObserver} method.
- */
-export declare class PointerObserver extends DomEventObserver<'pointerdown' | 'pointerup' | 'pointermove'> {
-    /**
-     * @inheritDoc
-     */
-    readonly domEventType: readonly ["pointerdown", "pointerup", "pointermove"];
-    /**
-     * @inheritDoc
-     */
-    onDomEvent(domEvent: PointerEvent): void;
+* Pointer events 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} by {@link module:engine/view/view~EditingView#addObserver} method.
+*/
+export declare class PointerObserver extends DomEventObserver<"pointerdown" | "pointerup" | "pointermove"> {
+	/**
+	* @inheritDoc
+	*/
+	readonly domEventType: readonly ["pointerdown", "pointerup", "pointermove"];
+	/**
+	* @inheritDoc
+	*/
+	onDomEvent(domEvent: PointerEvent): void;
 }
 /**
- * Fired when a pointer is down on one of the editing roots of the editor.
- *
- * Introduced by {@link module:engine/view/observer/pointerobserver~PointerObserver}.
- *
- * Note that this event is not available by default. To make it available,
- * {@link module:engine/view/observer/pointerobserver~PointerObserver} needs to be added to {@link module:engine/view/view~EditingView}
- * by the {@link module:engine/view/view~EditingView#addObserver} method.
- *
- * @see module:engine/view/observer/pointerobserver~PointerObserver
- * @eventName module:engine/view/document~ViewDocument#pointerdown
- * @param data The event data.
- */
+* Fired when a pointer is down on one of the editing roots of the editor.
+*
+* Introduced by {@link module:engine/view/observer/pointerobserver~PointerObserver}.
+*
+* Note that this event is not available by default. To make it available,
+* {@link module:engine/view/observer/pointerobserver~PointerObserver} needs to be added to {@link module:engine/view/view~EditingView}
+* by the {@link module:engine/view/view~EditingView#addObserver} method.
+*
+* @see module:engine/view/observer/pointerobserver~PointerObserver
+* @eventName module:engine/view/document~ViewDocument#pointerdown
+* @param data The event data.
+*/
 export type ViewDocumentPointerDownEvent = {
-    name: 'pointerdown';
-    args: [data: ViewDocumentDomEventData<PointerEvent>];
+	name: "pointerdown";
+	args: [data: ViewDocumentDomEventData<PointerEvent>];
 };
 /**
- * Fired when a pointer is up on one of the editing roots of the editor.
- *
- * Introduced by {@link module:engine/view/observer/pointerobserver~PointerObserver}.
- *
- * Note that this event is not available by default. To make it available,
- * {@link module:engine/view/observer/pointerobserver~PointerObserver} needs to be added to {@link module:engine/view/view~EditingView}
- * by the {@link module:engine/view/view~EditingView#addObserver} method.
- *
- * @see module:engine/view/observer/pointerobserver~PointerObserver
- * @eventName module:engine/view/document~ViewDocument#pointerup
- * @param data The event data.
- */
+* Fired when a pointer is up on one of the editing roots of the editor.
+*
+* Introduced by {@link module:engine/view/observer/pointerobserver~PointerObserver}.
+*
+* Note that this event is not available by default. To make it available,
+* {@link module:engine/view/observer/pointerobserver~PointerObserver} needs to be added to {@link module:engine/view/view~EditingView}
+* by the {@link module:engine/view/view~EditingView#addObserver} method.
+*
+* @see module:engine/view/observer/pointerobserver~PointerObserver
+* @eventName module:engine/view/document~ViewDocument#pointerup
+* @param data The event data.
+*/
 export type ViewDocumentPointerUpEvent = {
-    name: 'pointerup';
-    args: [data: ViewDocumentDomEventData<PointerEvent>];
+	name: "pointerup";
+	args: [data: ViewDocumentDomEventData<PointerEvent>];
 };
 /**
- * Fired when a pointer is moved on one of the editing roots of the editor.
- *
- * Introduced by {@link module:engine/view/observer/pointerobserver~PointerObserver}.
- *
- * Note that this event is not available by default. To make it available,
- * {@link module:engine/view/observer/pointerobserver~PointerObserver} needs to be added to {@link module:engine/view/view~EditingView}
- * by the {@link module:engine/view/view~EditingView#addObserver} method.
- *
- * @see module:engine/view/observer/pointerobserver~PointerObserver
- * @eventName module:engine/view/document~ViewDocument#pointermove
- * @param data The event data.
- */
+* Fired when a pointer is moved on one of the editing roots of the editor.
+*
+* Introduced by {@link module:engine/view/observer/pointerobserver~PointerObserver}.
+*
+* Note that this event is not available by default. To make it available,
+* {@link module:engine/view/observer/pointerobserver~PointerObserver} needs to be added to {@link module:engine/view/view~EditingView}
+* by the {@link module:engine/view/view~EditingView#addObserver} method.
+*
+* @see module:engine/view/observer/pointerobserver~PointerObserver
+* @eventName module:engine/view/document~ViewDocument#pointermove
+* @param data The event data.
+*/
 export type ViewDocumentPointerMoveEvent = {
-    name: 'pointermove';
-    args: [data: ViewDocumentDomEventData<PointerEvent>];
+	name: "pointermove";
+	args: [data: ViewDocumentDomEventData<PointerEvent>];
 };