@ckeditor/ckeditor5-engine

/** * @license Copyright (c) 2003-2025, 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/upcastwriter */ import { ViewDocumentFragment } from './documentfragment.js'; import { ViewElement, type ViewElementAttributes } from './element.js'; import { ViewText } from './text.js'; import { ViewPosition, type ViewPositionOffset } from './position.js'; import { ViewRange } from './range.js'; import { ViewSelection, type ViewPlaceOrOffset, type ViewSelectable, type ViewSelectionOptions } from './selection.js'; import { type ViewDocument } from './document.js'; import { type ViewItem } from './item.js'; import { type ViewNode } from './node.js'; /** * View upcast writer. It provides a set of methods used to manipulate non-semantic view trees. * * It should be used only while working on a non-semantic view * (e.g. a view created from HTML string on paste). * To manipulate a view which was or is being downcasted from the the model use the * {@link module:engine/view/downcastwriter~ViewDowncastWriter downcast writer}. * * Read more about changing the view in the {@glink framework/architecture/editing-engine#changing-the-view Changing the view} * section of the {@glink framework/architecture/editing-engine Editing engine architecture} guide. * * Unlike `ViewDowncastWriter`, which is available in the {@link module:engine/view/view~EditingView#change `View#change()`} block, * `ViewUpcastWriter` can be created wherever you need it: * * ```ts * const writer = new ViewUpcastWriter( viewDocument ); * const text = writer.createText( 'foo!' ); * * writer.appendChild( text, someViewElement ); * ``` */ export declare class ViewUpcastWriter { /** * The view document instance in which this upcast writer operates. */ readonly document: ViewDocument; /** * @param document The view document instance in which this upcast writer operates. */ constructor(document: ViewDocument); /** * Creates a new {@link module:engine/view/documentfragment~ViewDocumentFragment} instance. * * @param children A list of nodes to be inserted into the created document fragment. * @returns The created document fragment. */ createDocumentFragment(children?: ViewNode | Iterable<ViewNode>): ViewDocumentFragment; /** * Creates a new {@link module:engine/view/element~ViewElement} instance. * * Attributes can be passed in various formats: * * ```ts * upcastWriter.createElement( 'div', { class: 'editor', contentEditable: 'true' } ); // object * upcastWriter.createElement( 'div', [ [ 'class', 'editor' ], [ 'contentEditable', 'true' ] ] ); // map-like iterator * upcastWriter.createElement( 'div', mapOfAttributes ); // map * ``` * * @param name Node name. * @param attrs Collection of attributes. * @param children A list of nodes to be inserted into created element. * @returns Created element. */ createElement(name: string, attrs?: ViewElementAttributes, children?: ViewNode | Iterable<ViewNode>): ViewElement; /** * Creates a new {@link module:engine/view/text~ViewText} instance. * * @param data The text's data. * @returns The created text node. */ createText(data: string): ViewText; /** * Clones the provided element. * * @see module:engine/view/element~ViewElement#_clone * @param element Element to be cloned. * @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(element: ViewElement, deep?: boolean): ViewElement; /** * Appends a child node or a list of child nodes at the end of this node * and sets the parent of these nodes to this element. * * @see module:engine/view/element~ViewElement#_appendChild * @param items Items to be inserted. * @param element Element to which items will be appended. * @returns Number of appended nodes. */ appendChild(items: ViewItem | string | Iterable<ViewItem | string>, element: ViewElement | ViewDocumentFragment): number; /** * Inserts a child node or a list of child nodes on the given index and sets the parent of these nodes to * this element. * * @see module:engine/view/element~ViewElement#_insertChild * @param index Offset at which nodes should be inserted. * @param items Items to be inserted. * @param element Element to which items will be inserted. * @returns Number of inserted nodes. */ insertChild(index: number, items: ViewItem | Iterable<ViewItem>, element: ViewElement | ViewDocumentFragment): number; /** * Removes the given number of child nodes starting at the given index and set the parent of these nodes to `null`. * * @see module:engine/view/element~ViewElement#_removeChildren * @param index Offset from which nodes will be removed. * @param howMany Number of nodes to remove. * @param element Element which children will be removed. * @returns The array containing removed nodes. */ removeChildren(index: number, howMany: number, element: ViewElement | ViewDocumentFragment): Array<ViewNode>; /** * Removes given element from the view structure. Will not have effect on detached elements. * * @param element Element which will be removed. * @returns The array containing removed nodes. */ remove(element: ViewNode): Array<ViewNode>; /** * Replaces given element with the new one in the view structure. Will not have effect on detached elements. * * @param oldElement Element which will be replaced. * @param newElement Element which will be inserted in the place of the old element. * @returns Whether old element was successfully replaced. */ replace(oldElement: ViewElement, newElement: ViewElement): boolean; /** * Removes given element from view structure and places its children in its position. * It does nothing if element has no parent. * * @param element Element to unwrap. */ unwrapElement(element: ViewElement): void; /** * Renames element by creating a copy of a given element but with its name changed and then moving contents of the * old element to the new one. * * Since this function creates a new element and removes the given one, the new element is returned to keep reference. * * @param newName New element name. * @param element Element to be renamed. * @returns New element or null if the old element was not replaced (happens for detached elements). */ rename(newName: string, element: ViewElement): ViewElement | null; /** * Adds or overwrites element's attribute with a specified key and value. * * ```ts * writer.setAttribute( 'href', 'http://ckeditor.com', linkElement ); * ``` * * @see module:engine/view/element~ViewElement#_setAttribute * @param key Attribute key. * @param value Attribute value. * @param element Element for which attribute will be set. */ setAttribute(key: string, value: unknown, element: ViewElement): void; /** * Removes attribute from the element. * * ```ts * writer.removeAttribute( 'href', linkElement ); * ``` * * @see module:engine/view/element~ViewElement#_removeAttribute * @param key Attribute key. * @param element Element from which attribute will be removed. */ removeAttribute(key: string, element: ViewElement): void; /** * Adds specified class to the element. * * ```ts * writer.addClass( 'foo', linkElement ); * writer.addClass( [ 'foo', 'bar' ], linkElement ); * ``` * * @see module:engine/view/element~ViewElement#_addClass * @param className Single class name or array of class names which will be added. * @param element Element for which class will be added. */ addClass(className: string | Array<string>, element: ViewElement): void; /** * Removes specified class from the element. * * ```ts * writer.removeClass( 'foo', linkElement ); * writer.removeClass( [ 'foo', 'bar' ], linkElement ); * ``` * * @see module:engine/view/element~ViewElement#_removeClass * @param className Single class name or array of class names which will be removed. * @param element Element from which class will be removed. */ removeClass(className: string | Array<string>, element: ViewElement): void; /** * Adds style to the element. * * ```ts * writer.setStyle( 'color', 'red', element ); * ``` * * **Note**: This method can work with normalized style names if * {@link module:engine/controller/datacontroller~DataController#addStyleProcessorRules a particular style processor rule is enabled}. * See {@link module:engine/view/stylesmap~StylesMap#set `StylesMap#set()`} for details. * * @see module:engine/view/element~ViewElement#_setStyle * @label KEY_VALUE * @param property Property name. * @param value Value to set. * @param element Element for which style will be added. */ setStyle(property: string, value: string, element: ViewElement): void; /** * Adds style to the element. * * ```ts * writer.setStyle( { * color: 'red', * position: 'fixed' * }, element ); * ``` * * **Note**: This method can work with normalized style names if * {@link module:engine/controller/datacontroller~DataController#addStyleProcessorRules a particular style processor rule is enabled}. * See {@link module:engine/view/stylesmap~StylesMap#set `StylesMap#set()`} for details. * * @see module:engine/view/element~ViewElement#_setStyle * @label OBJECT * @param properties Object with key - value pairs. * @param element Element for which style will be added. */ setStyle(properties: Record<string, string>, element: ViewElement): void; /** * Removes specified style from the element. * * ```ts * writer.removeStyle( 'color', element ); // Removes 'color' style. * writer.removeStyle( [ 'color', 'border-top' ], element ); // Removes both 'color' and 'border-top' styles. * ``` * * **Note**: This method can work with normalized style names if * {@link module:engine/controller/datacontroller~DataController#addStyleProcessorRules a particular style processor rule is enabled}. * See {@link module:engine/view/stylesmap~StylesMap#remove `StylesMap#remove()`} for details. * * @see module:engine/view/element~ViewElement#_removeStyle * @param property Style property name or names to be removed. * @param element Element from which style will be removed. */ removeStyle(property: string | Array<string>, element: ViewElement): void; /** * Sets a custom property on element. Unlike attributes, custom properties are not rendered to the DOM, * so they can be used to add special data to elements. * * @see module:engine/view/element~ViewElement#_setCustomProperty * @param key Custom property name/key. * @param value Custom property value to be stored. * @param element Element for which custom property will be set. */ setCustomProperty(key: string | symbol, value: unknown, element: ViewElement | ViewDocumentFragment): void; /** * Removes a custom property stored under the given key. * * @see module:engine/view/element~ViewElement#_removeCustomProperty * @param key Name/key of the custom property to be removed. * @param element Element from which the custom property will be removed. * @returns Returns true if property was removed. */ removeCustomProperty(key: string | symbol, element: ViewElement | ViewDocumentFragment): boolean; /** * Creates position at the given location. The location can be specified as: * * * a {@link module:engine/view/position~ViewPosition position}, * * parent element and offset (offset defaults to `0`), * * parent element and `'end'` (sets position at the end of that element), * * {@link module:engine/view/item~ViewItem view item} and `'before'` or `'after'` (sets position before or after given view item). * * This method is a shortcut to other constructors such as: * * * {@link #createPositionBefore}, * * {@link #createPositionAfter}, * * @param offset Offset or one of the flags. Used only when first parameter is a {@link module:engine/view/item~ViewItem view item}. */ createPositionAt(itemOrPosition: ViewItem | ViewPosition, offset?: ViewPositionOffset): ViewPosition; /** * Creates a new position after given view item. * * @param item View item after which the position should be located. */ createPositionAfter(item: ViewItem): ViewPosition; /** * Creates a new position before given view item. * * @param item View item before which the position should be located. */ createPositionBefore(item: ViewItem): ViewPosition; /** * Creates a range spanning from `start` position to `end` position. * * **Note:** This factory method creates it's own {@link module:engine/view/position~ViewPosition} instances basing on passed values. * * @param start Start position. * @param end End position. If not set, range will be collapsed at `start` position. */ createRange(start: ViewPosition, end: ViewPosition): ViewRange; /** * Creates a range that starts before given {@link module:engine/view/item~ViewItem view item} and ends after it. */ createRangeOn(item: ViewItem): ViewRange; /** * Creates a range inside an {@link module:engine/view/element~ViewElement element} which starts before the first child of * that element and ends after the last child of that element. * * @param element Element which is a parent for the range. */ createRangeIn(element: ViewElement | ViewDocumentFragment): ViewRange; /** * Creates a new {@link module:engine/view/selection~ViewSelection} instance. * * ```ts * // Creates collapsed selection at the position of given item and offset. * const paragraph = writer.createContainerElement( 'paragraph' ); * const selection = writer.createSelection( paragraph, offset ); * * // Creates a range inside an {@link module:engine/view/element~ViewElement element} which starts before the * // first child of that element and ends after the last child of that element. * const selection = writer.createSelection( paragraph, 'in' ); * * // Creates a range on an {@link module:engine/view/item~ViewItem item} which starts before the item and ends * // just after the item. * const selection = writer.createSelection( paragraph, 'on' ); * ``` * * `Selection`'s constructor allow passing additional options (`backward`, `fake` and `label`) as the last argument. * * ```ts * // Creates backward selection. * const selection = writer.createSelection( element, 'in', { backward: true } ); * ``` * * Fake selection does not render as browser native selection over selected elements and is hidden to the user. * This way, no native selection UI artifacts are displayed to the user and selection over elements can be * represented in other way, for example by applying proper CSS class. * * Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM * (and be properly handled by screen readers). * * ```ts * // Creates fake selection with label. * const selection = writer.createSelection( element, 'in', { fake: true, label: 'foo' } ); * ``` * * See also: {@link #createSelection:SELECTABLE `createSelection( selectable, options )`}. * * @label NODE_OFFSET */ createSelection(selectable: ViewNode, placeOrOffset: ViewPlaceOrOffset, options?: ViewSelectionOptions): ViewSelection; /** * Creates a new {@link module:engine/view/selection~ViewSelection} instance. * * ```ts * // Creates empty selection without ranges. * const selection = writer.createSelection(); * * // Creates selection at the given range. * const range = writer.createRange( start, end ); * const selection = writer.createSelection( range ); * * // Creates selection at the given ranges * const ranges = [ writer.createRange( start1, end2 ), writer.createRange( star2, end2 ) ]; * const selection = writer.createSelection( ranges ); * * // Creates selection from the other selection. * const otherSelection = writer.createSelection(); * const selection = writer.createSelection( otherSelection ); * * // Creates selection from the document selection. * const selection = writer.createSelection( editor.editing.view.document.selection ); * * // Creates selection at the given position. * const position = writer.createPositionFromPath( root, path ); * const selection = writer.createSelection( position ); * ``` * * `Selection`'s constructor allow passing additional options (`backward`, `fake` and `label`) as the last argument. * * ```ts * // Creates backward selection. * const selection = writer.createSelection( range, { backward: true } ); * ``` * * Fake selection does not render as browser native selection over selected elements and is hidden to the user. * This way, no native selection UI artifacts are displayed to the user and selection over elements can be * represented in other way, for example by applying proper CSS class. * * Additionally fake's selection label can be provided. It will be used to describe fake selection in DOM * (and be properly handled by screen readers). * * ```ts * // Creates fake selection with label. * const selection = writer.createSelection( range, { fake: true, label: 'foo' } ); * ``` * * See also: {@link #createSelection:NODE_OFFSET `createSelection( node, placeOrOffset, options )`}. * * @label SELECTABLE */ createSelection(selectable?: Exclude<ViewSelectable, ViewNode>, options?: ViewSelectionOptions): ViewSelection; }