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

package/dist/view/attributeelement.d.ts

@@ -1,128 +1,128 @@
 /**
- * @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/attributeelement
- */
-import { ViewElement, type ViewElementAttributes } from './element.js';
-import { type ViewDocument } from './document.js';
-import { type ViewNode } from './node.js';
+* @module engine/view/attributeelement
+*/
+import { ViewElement, type ViewElementAttributes } from "./element.js";
+import { type ViewDocument } from "./document.js";
+import { type ViewNode } from "./node.js";
 /**
- * Attribute elements are used to represent formatting elements in the view (think – `<b>`, `<span style="font-size: 2em">`, etc.).
- * Most often they are created when downcasting model text attributes.
- *
- * Editing engine does not define a fixed HTML DTD. This is why a feature developer needs to choose between various
- * types (container element, {@link module:engine/view/attributeelement~ViewAttributeElement attribute element},
- * {@link module:engine/view/emptyelement~ViewEmptyElement empty element}, etc) when developing a feature.
- *
- * To create a new attribute element instance use the
- * {@link module:engine/view/downcastwriter~ViewDowncastWriter#createAttributeElement `ViewDowncastWriter#createAttributeElement()`} method.
- */
+* Attribute elements are used to represent formatting elements in the view (think – `<b>`, `<span style="font-size: 2em">`, etc.).
+* Most often they are created when downcasting model text attributes.
+*
+* Editing engine does not define a fixed HTML DTD. This is why a feature developer needs to choose between various
+* types (container element, {@link module:engine/view/attributeelement~ViewAttributeElement attribute element},
+* {@link module:engine/view/emptyelement~ViewEmptyElement empty element}, etc) when developing a feature.
+*
+* To create a new attribute element instance use the
+* {@link module:engine/view/downcastwriter~ViewDowncastWriter#createAttributeElement `ViewDowncastWriter#createAttributeElement()`} method.
+*/
 export declare class ViewAttributeElement extends ViewElement {
-    static readonly DEFAULT_PRIORITY: number;
-    /**
-     * Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~ViewDowncastWriter}.
-     *
-     * @internal
-     * @readonly
-     */
-    _priority: number;
-    /**
-     * Element identifier. If set, it is used by {@link module:engine/view/element~ViewElement#isSimilar},
-     * and then two elements are considered similar if, and only if they have the same `_id`.
-     *
-     * @internal
-     * @readonly
-     */
-    _id: string | number | null;
-    /**
-     * Keeps all the attribute elements that have the same {@link module:engine/view/attributeelement~ViewAttributeElement#id ids}
-     * and still exist in the view tree.
-     *
-     * This property is managed by {@link module:engine/view/downcastwriter~ViewDowncastWriter}.
-     */
-    private readonly _clonesGroup;
-    /**
-     * Creates an attribute element.
-     *
-     * @see module:engine/view/downcastwriter~ViewDowncastWriter#createAttributeElement
-     * @see module:engine/view/element~ViewElement
-     * @protected
-     * @param document The document instance to which this element belongs.
-     * @param name Node name.
-     * @param attrs Collection of attributes.
-     * @param children A list of nodes to be inserted into created element.
-     */
-    constructor(document: ViewDocument, name: string, attrs?: ViewElementAttributes, children?: ViewNode | Iterable<ViewNode>);
-    /**
-     * Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~ViewDowncastWriter}.
-     */
-    get priority(): number;
-    /**
-     * Element identifier. If set, it is used by {@link module:engine/view/element~ViewElement#isSimilar},
-     * and then two elements are considered similar if, and only if they have the same `id`.
-     */
-    get id(): string | number | null;
-    /**
-     * Returns all {@link module:engine/view/attributeelement~ViewAttributeElement attribute elements} that has the
-     * same {@link module:engine/view/attributeelement~ViewAttributeElement#id id} and are in the view tree (were not removed).
-     *
-     * Note: If this element has been removed from the tree, returned set will not include it.
-     *
-     * Throws {@link module:utils/ckeditorerror~CKEditorError attribute-element-get-elements-with-same-id-no-id}
-     * if this element has no `id`.
-     *
-     * @returns Set containing all the attribute elements
-     * with the same `id` that were added and not removed from the view tree.
-     */
-    getElementsWithSameId(): Set<ViewAttributeElement>;
-    /**
-     * Checks if this element is similar to other element.
-     *
-     * If none of elements has set {@link module:engine/view/attributeelement~ViewAttributeElement#id}, then both elements
-     * should have the same name, attributes and priority to be considered as similar. Two similar elements can contain
-     * different set of children nodes.
-     *
-     * If at least one element has {@link module:engine/view/attributeelement~ViewAttributeElement#id} set, then both
-     * elements have to have the same {@link module:engine/view/attributeelement~ViewAttributeElement#id} value to be
-     * considered similar.
-     *
-     * Similarity is important for {@link module:engine/view/downcastwriter~ViewDowncastWriter}. For example:
-     *
-     * * two following similar elements can be merged together into one, longer element,
-     * * {@link module:engine/view/downcastwriter~ViewDowncastWriter#unwrap} checks similarity of passed element and processed element to
-     * decide whether processed element should be unwrapped,
-     * * etc.
-     */
-    isSimilar(otherElement: ViewElement): boolean;
-    /**
-     * Converts `ViewAttributeElement` instance to plain object and returns it.
-     *
-     * @returns `ViewAttributeElement` instance converted to plain object.
-     */
-    toJSON(): unknown;
-    /**
-     * Clones provided element with priority.
-     *
-     * @internal
-     * @param deep If set to `true` clones element and all its children recursively. When set to `false`,
-     * element will be cloned without any children.
-     * @returns Clone of this element.
-     */
-    _clone(deep?: boolean): this;
-    /**
-     * Used by {@link module:engine/view/element~ViewElement#_mergeAttributesFrom} to verify if the given element can be merged without
-     * conflicts into this element.
-     *
-     * @internal
-     */
-    _canMergeAttributesFrom(otherElement: ViewAttributeElement): boolean;
-    /**
-     * Used by {@link module:engine/view/element~ViewElement#_subtractAttributesOf} to verify if the given element attributes
-     * can be fully subtracted from this element.
-     *
-     * @internal
-     */
-    _canSubtractAttributesOf(otherElement: ViewAttributeElement): boolean;
+	static readonly DEFAULT_PRIORITY: number;
+	/**
+	* Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~ViewDowncastWriter}.
+	*
+	* @internal
+	* @readonly
+	*/
+	_priority: number;
+	/**
+	* Element identifier. If set, it is used by {@link module:engine/view/element~ViewElement#isSimilar},
+	* and then two elements are considered similar if, and only if they have the same `_id`.
+	*
+	* @internal
+	* @readonly
+	*/
+	_id: string | number | null;
+	/**
+	* Keeps all the attribute elements that have the same {@link module:engine/view/attributeelement~ViewAttributeElement#id ids}
+	* and still exist in the view tree.
+	*
+	* This property is managed by {@link module:engine/view/downcastwriter~ViewDowncastWriter}.
+	*/
+	private readonly _clonesGroup;
+	/**
+	* Creates an attribute element.
+	*
+	* @see module:engine/view/downcastwriter~ViewDowncastWriter#createAttributeElement
+	* @see module:engine/view/element~ViewElement
+	* @protected
+	* @param document The document instance to which this element belongs.
+	* @param name Node name.
+	* @param attrs Collection of attributes.
+	* @param children A list of nodes to be inserted into created element.
+	*/
+	constructor(document: ViewDocument, name: string, attrs?: ViewElementAttributes, children?: ViewNode | Iterable<ViewNode>);
+	/**
+	* Element priority. Decides in what order elements are wrapped by {@link module:engine/view/downcastwriter~ViewDowncastWriter}.
+	*/
+	get priority(): number;
+	/**
+	* Element identifier. If set, it is used by {@link module:engine/view/element~ViewElement#isSimilar},
+	* and then two elements are considered similar if, and only if they have the same `id`.
+	*/
+	get id(): string | number | null;
+	/**
+	* Returns all {@link module:engine/view/attributeelement~ViewAttributeElement attribute elements} that has the
+	* same {@link module:engine/view/attributeelement~ViewAttributeElement#id id} and are in the view tree (were not removed).
+	*
+	* Note: If this element has been removed from the tree, returned set will not include it.
+	*
+	* Throws {@link module:utils/ckeditorerror~CKEditorError attribute-element-get-elements-with-same-id-no-id}
+	* if this element has no `id`.
+	*
+	* @returns Set containing all the attribute elements
+	* with the same `id` that were added and not removed from the view tree.
+	*/
+	getElementsWithSameId(): Set<ViewAttributeElement>;
+	/**
+	* Checks if this element is similar to other element.
+	*
+	* If none of elements has set {@link module:engine/view/attributeelement~ViewAttributeElement#id}, then both elements
+	* should have the same name, attributes and priority to be considered as similar. Two similar elements can contain
+	* different set of children nodes.
+	*
+	* If at least one element has {@link module:engine/view/attributeelement~ViewAttributeElement#id} set, then both
+	* elements have to have the same {@link module:engine/view/attributeelement~ViewAttributeElement#id} value to be
+	* considered similar.
+	*
+	* Similarity is important for {@link module:engine/view/downcastwriter~ViewDowncastWriter}. For example:
+	*
+	* * two following similar elements can be merged together into one, longer element,
+	* * {@link module:engine/view/downcastwriter~ViewDowncastWriter#unwrap} checks similarity of passed element and processed element to
+	* decide whether processed element should be unwrapped,
+	* * etc.
+	*/
+	override isSimilar(otherElement: ViewElement): boolean;
+	/**
+	* Converts `ViewAttributeElement` instance to plain object and returns it.
+	*
+	* @returns `ViewAttributeElement` instance converted to plain object.
+	*/
+	override toJSON(): unknown;
+	/**
+	* Clones provided element with priority.
+	*
+	* @internal
+	* @param deep If set to `true` clones element and all its children recursively. When set to `false`,
+	* element will be cloned without any children.
+	* @returns Clone of this element.
+	*/
+	override _clone(deep?: boolean): this;
+	/**
+	* Used by {@link module:engine/view/element~ViewElement#_mergeAttributesFrom} to verify if the given element can be merged without
+	* conflicts into this element.
+	*
+	* @internal
+	*/
+	override _canMergeAttributesFrom(otherElement: ViewAttributeElement): boolean;
+	/**
+	* Used by {@link module:engine/view/element~ViewElement#_subtractAttributesOf} to verify if the given element attributes
+	* can be fully subtracted from this element.
+	*
+	* @internal
+	*/
+	override _canSubtractAttributesOf(otherElement: ViewAttributeElement): boolean;
 }

package/dist/view/containerelement.d.ts

@@ -1,56 +1,56 @@
 /**
- * @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/containerelement
- */
-import { ViewElement, type ViewElementAttributes } from './element.js';
-import { type ViewDocument } from './document.js';
-import { type ViewNode } from './node.js';
+* @module engine/view/containerelement
+*/
+import { ViewElement, type ViewElementAttributes } from "./element.js";
+import { type ViewDocument } from "./document.js";
+import { type ViewNode } from "./node.js";
 /**
- * Containers are elements which define document structure. They define boundaries for
- * {@link module:engine/view/attributeelement~ViewAttributeElement attributes}.
- * They are mostly used for block elements like `<p>` or `<div>`.
- *
- * Editing engine does not define a fixed HTML DTD. This is why a feature developer needs to choose between various
- * types (container element, {@link module:engine/view/attributeelement~ViewAttributeElement attribute element},
- * {@link module:engine/view/emptyelement~ViewEmptyElement empty element}, etc) when developing a feature.
- *
- * The container element should be your default choice when writing a converter, unless:
- *
- * * this element represents a model text attribute (then use {@link module:engine/view/attributeelement~ViewAttributeElement}),
- * * this is an empty element like `<img>` (then use {@link module:engine/view/emptyelement~ViewEmptyElement}),
- * * this is a root element,
- * * this is a nested editable element (then use  {@link module:engine/view/editableelement~ViewEditableElement}).
- *
- * To create a new container element instance use the
- * {@link module:engine/view/downcastwriter~ViewDowncastWriter#createContainerElement `ViewDowncastWriter#createContainerElement()`}
- * method.
- */
+* Containers are elements which define document structure. They define boundaries for
+* {@link module:engine/view/attributeelement~ViewAttributeElement attributes}.
+* They are mostly used for block elements like `<p>` or `<div>`.
+*
+* Editing engine does not define a fixed HTML DTD. This is why a feature developer needs to choose between various
+* types (container element, {@link module:engine/view/attributeelement~ViewAttributeElement attribute element},
+* {@link module:engine/view/emptyelement~ViewEmptyElement empty element}, etc) when developing a feature.
+*
+* The container element should be your default choice when writing a converter, unless:
+*
+* * this element represents a model text attribute (then use {@link module:engine/view/attributeelement~ViewAttributeElement}),
+* * this is an empty element like `<img>` (then use {@link module:engine/view/emptyelement~ViewEmptyElement}),
+* * this is a root element,
+* * this is a nested editable element (then use  {@link module:engine/view/editableelement~ViewEditableElement}).
+*
+* To create a new container element instance use the
+* {@link module:engine/view/downcastwriter~ViewDowncastWriter#createContainerElement `ViewDowncastWriter#createContainerElement()`}
+* method.
+*/
 export declare class ViewContainerElement extends ViewElement {
-    /**
-     * Creates a container element.
-     *
-     * @see module:engine/view/downcastwriter~ViewDowncastWriter#createContainerElement
-     * @see module:engine/view/element~ViewElement
-     * @internal
-     * @param document The document instance to which this element belongs.
-     * @param name Node name.
-     * @param attrs Collection of attributes.
-     * @param children A list of nodes to be inserted into created element.
-     */
-    constructor(document: ViewDocument, name: string, attrs?: ViewElementAttributes, children?: ViewNode | Iterable<ViewNode>);
-    /**
-     * Converts `ViewContainerElement` instance to plain object and returns it.
-     *
-     * @returns `ViewContainerElement` instance converted to plain object.
-     */
-    toJSON(): unknown;
+	/**
+	* Creates a container element.
+	*
+	* @see module:engine/view/downcastwriter~ViewDowncastWriter#createContainerElement
+	* @see module:engine/view/element~ViewElement
+	* @internal
+	* @param document The document instance to which this element belongs.
+	* @param name Node name.
+	* @param attrs Collection of attributes.
+	* @param children A list of nodes to be inserted into created element.
+	*/
+	constructor(document: ViewDocument, name: string, attrs?: ViewElementAttributes, children?: ViewNode | Iterable<ViewNode>);
+	/**
+	* Converts `ViewContainerElement` instance to plain object and returns it.
+	*
+	* @returns `ViewContainerElement` instance converted to plain object.
+	*/
+	override toJSON(): unknown;
 }
 /**
- * Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed.
- *
- * @returns Block filler offset or `null` if block filler is not needed.
- */
+* Returns block {@link module:engine/view/filler filler} offset or `null` if block filler is not needed.
+*
+* @returns Block filler offset or `null` if block filler is not needed.
+*/
 export declare function getViewFillerOffset(this: ViewContainerElement): number | null;

package/dist/view/datatransfer.d.ts

@@ -1,79 +1,79 @@
 /**
- * @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/datatransfer
- */
+* @module engine/view/datatransfer
+*/
 type DomDataTransfer = globalThis.DataTransfer;
 /**
- * A facade over the native [`DataTransfer`](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer) object.
- */
+* A facade over the native [`DataTransfer`](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer) object.
+*/
 export declare class ViewDataTransfer {
-    /**
-     * The array of files created from the native `DataTransfer#files` or `DataTransfer#items`.
-     */
-    private _files;
-    /**
-     * The native DataTransfer object.
-     */
-    private _native;
-    /**
-     * @param nativeDataTransfer The native [`DataTransfer`](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer) object.
-     * @param options.cacheFiles Whether `files` list should be initialized in the constructor.
-     */
-    constructor(nativeDataTransfer: DomDataTransfer, options?: {
-        cacheFiles?: boolean;
-    });
-    /**
-     * The array of files created from the native `DataTransfer#files` or `DataTransfer#items`.
-     */
-    get files(): Array<File>;
-    /**
-     * Returns an array of available native content types.
-     */
-    get types(): ReadonlyArray<string>;
-    /**
-     * Gets the data from the data transfer by its MIME type.
-     *
-     * ```ts
-     * dataTransfer.getData( 'text/plain' );
-     * ```
-     *
-     * @param type The MIME type. E.g. `text/html` or `text/plain`.
-     */
-    getData(type: string): string;
-    /**
-     * Sets the data in the data transfer.
-     *
-     * @param type The MIME type. E.g. `text/html` or `text/plain`.
-     */
-    setData(type: string, data: string): void;
-    /**
-     * The effect that is allowed for a drag operation.
-     */
-    set effectAllowed(value: ViewEffectAllowed);
-    get effectAllowed(): ViewEffectAllowed;
-    /**
-     * The actual drop effect.
-     */
-    set dropEffect(value: ViewDropEffect);
-    get dropEffect(): ViewDropEffect;
-    /**
-     * Set a preview image of the dragged content.
-     */
-    setDragImage(image: Element, x: number, y: number): void;
-    /**
-     * Whether the dragging operation was canceled.
-     */
-    get isCanceled(): boolean;
+	/**
+	* The array of files created from the native `DataTransfer#files` or `DataTransfer#items`.
+	*/
+	private _files;
+	/**
+	* The native DataTransfer object.
+	*/
+	private _native;
+	/**
+	* @param nativeDataTransfer The native [`DataTransfer`](https://developer.mozilla.org/en-US/docs/Web/API/DataTransfer) object.
+	* @param options.cacheFiles Whether `files` list should be initialized in the constructor.
+	*/
+	constructor(nativeDataTransfer: DomDataTransfer, options?: {
+		cacheFiles?: boolean;
+	});
+	/**
+	* The array of files created from the native `DataTransfer#files` or `DataTransfer#items`.
+	*/
+	get files(): Array<File>;
+	/**
+	* Returns an array of available native content types.
+	*/
+	get types(): ReadonlyArray<string>;
+	/**
+	* Gets the data from the data transfer by its MIME type.
+	*
+	* ```ts
+	* dataTransfer.getData( 'text/plain' );
+	* ```
+	*
+	* @param type The MIME type. E.g. `text/html` or `text/plain`.
+	*/
+	getData(type: string): string;
+	/**
+	* Sets the data in the data transfer.
+	*
+	* @param type The MIME type. E.g. `text/html` or `text/plain`.
+	*/
+	setData(type: string, data: string): void;
+	/**
+	* The effect that is allowed for a drag operation.
+	*/
+	set effectAllowed(value: ViewEffectAllowed);
+	get effectAllowed(): ViewEffectAllowed;
+	/**
+	* The actual drop effect.
+	*/
+	set dropEffect(value: ViewDropEffect);
+	get dropEffect(): ViewDropEffect;
+	/**
+	* Set a preview image of the dragged content.
+	*/
+	setDragImage(image: Element, x: number, y: number): void;
+	/**
+	* Whether the dragging operation was canceled.
+	*/
+	get isCanceled(): boolean;
 }
 /**
- * The effect that is allowed for a drag operation.
- */
-export type ViewEffectAllowed = DomDataTransfer['effectAllowed'];
+* The effect that is allowed for a drag operation.
+*/
+export type ViewEffectAllowed = DomDataTransfer["effectAllowed"];
 /**
- * The actual drop effect.
- */
-export type ViewDropEffect = DomDataTransfer['dropEffect'];
+* The actual drop effect.
+*/
+export type ViewDropEffect = DomDataTransfer["dropEffect"];
 export {};