CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

UpcastWriter (engine/view)

@ckeditor/ckeditor5-engine/src/view/upcastwriter

class
See source

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 downcast writer.

Read more about changing the view in the Changing the view section of the Editing engine architecture guide.

Unlike DowncastWriter, which is available in the View#change() block, UpcastWriter can be created wherever you need it:

const writer = new UpcastWriter( viewDocument );
const text = writer.createText( 'foo!' );

writer.appendChild( text, someViewElement );

Filtering

Properties

  • readonly

    document : Document

    See source

    The view document instance in which this upcast writer operates.

Methods

  • constructor( document )

    See source

    Parameters

    document : Document

    The view document instance in which this upcast writer operates.

  • addClass( className, element ) → void

    See source

    Adds specified class to the element.

    writer.addClass( 'foo', linkElement );
writer.addClass( [ 'foo', 'bar' ], linkElement );

    Parameters

    className : string | Array<string>

    Single class name or array of class names which will be added.

    element : Element

    Element for which class will be added.

    Returns

    void

    Related:

  • appendChild( items, element ) → number

    See source

    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.

    Parameters

    items : string | Item | Iterable<string | Item>

    Items to be inserted.

    element : Element | DocumentFragment

    Element to which items will be appended.

    Returns

    number

    Number of appended nodes.

    Related:

  • clone( element, deep ) → Element

    See source

    Clones the provided element.

    Parameters

    element : Element

    Element to be cloned.

    deep : boolean

    If set to true clones element and all its children recursively. When set to false, element will be cloned without any children.

    Defaults to false

    Returns

    Element

    Clone of this element.

    Related:

  • createDocumentFragment( [ children ] ) → DocumentFragment

    See source

    Creates a new DocumentFragment instance.

    Parameters

    [ children ] : Node | Iterable<Node>

    A list of nodes to be inserted into the created document fragment.

    Returns

    DocumentFragment

    The created document fragment.

  • createElement( name, [ attrs ], [ children ] ) → Element

    See source

    Creates a new Element instance.

    Attributes can be passed in various formats:

    upcastWriter.createElement( 'div', { class: 'editor', contentEditable: 'true' } ); // object
upcastWriter.createElement( 'div', [ [ 'class', 'editor' ], [ 'contentEditable', 'true' ] ] ); // map-like iterator
upcastWriter.createElement( 'div', mapOfAttributes ); // map

    Parameters

    name : string

    Node name.

    [ attrs ] : ElementAttributes

    Collection of attributes.

    [ children ] : Node | Iterable<Node>

    A list of nodes to be inserted into created element.

    Returns

    Element

    Created element.

  • createPositionAfter( item ) → Position

    See source

    Creates a new position after given view item.

    Parameters

    item : Item

    View item after which the position should be located.

    Returns

    Position

  • createPositionAt( itemOrPosition, [ offset ] ) → Position

    See source

    Creates position at the given location. The location can be specified as:

    • a position,
    • parent element and offset (offset defaults to 0),
    • parent element and 'end' (sets position at the end of that element),
    • view item and 'before' or 'after' (sets position before or after given view item).

    This method is a shortcut to other constructors such as:

    Parameters

    itemOrPosition : Position | Item
    [ offset ] : PositionOffset

    Offset or one of the flags. Used only when first parameter is a view item.

    Returns

    Position

  • createPositionBefore( item ) → Position

    See source

    Creates a new position before given view item.

    Parameters

    item : Item

    View item before which the position should be located.

    Returns

    Position

  • createRange( start, end ) → Range

    See source

    Creates a range spanning from start position to end position.

    Note: This factory method creates it's own Position instances basing on passed values.

    Parameters

    start : Position

    Start position.

    end : Position

    End position. If not set, range will be collapsed at start position.

    Returns

    Range

  • createRangeIn( element ) → Range

    See source

    Creates a range inside an element which starts before the first child of that element and ends after the last child of that element.

    Parameters

    element : Element | DocumentFragment

    Element which is a parent for the range.

    Returns

    Range

  • createRangeOn( item ) → Range

    See source

    Creates a range that starts before given view item and ends after it.

    Parameters

    item : Item

    Returns

    Range

  • createSelection( [ selectable ], [ options ] ) → Selection

    See source

    Creates a new Selection instance.

    // 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.

    // 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).

    // Creates fake selection with label.
const selection = writer.createSelection( range, { fake: true, label: 'foo' } );

    See also: createSelection( node, placeOrOffset, options ).

    Parameters

    [ selectable ] : null | Position | Range | Selection | DocumentSelection | Iterable<Range>
    [ options ] : SelectionOptions

    Returns

    Selection

  • createSelection( selectable, placeOrOffset, [ options ] ) → Selection

    See source

    Creates a new Selection instance.

    // 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 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 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.

    // 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).

    // Creates fake selection with label.
const selection = writer.createSelection( element, 'in', { fake: true, label: 'foo' } );

    See also: createSelection( selectable, options ).

    Parameters

    selectable : Node
    placeOrOffset : PlaceOrOffset
    [ options ] : SelectionOptions

    Returns

    Selection

  • createText( data ) → Text

    See source

    Creates a new Text instance.

    Parameters

    data : string

    The text's data.

    Returns

    Text

    The created text node.

  • insertChild( index, items, element ) → number

    See source

    Inserts a child node or a list of child nodes on the given index and sets the parent of these nodes to this element.

    Parameters

    index : number

    Offset at which nodes should be inserted.

    items : Item | Iterable<Item>

    Items to be inserted.

    element : Element | DocumentFragment

    Element to which items will be inserted.

    Returns

    number

    Number of inserted nodes.

    Related:

  • remove( element ) → Array<Node>

    See source

    Removes given element from the view structure. Will not have effect on detached elements.

    Parameters

    element : Node

    Element which will be removed.

    Returns

    Array<Node>

    The array containing removed nodes.

  • removeAttribute( key, element ) → void

    See source

    Removes attribute from the element.

    writer.removeAttribute( 'href', linkElement );

    Parameters

    key : string

    Attribute key.

    element : Element

    Element from which attribute will be removed.

    Returns

    void

    Related:

  • removeChildren( index, howMany, element ) → Array<Node>

    See source

    Removes the given number of child nodes starting at the given index and set the parent of these nodes to null.

    Parameters

    index : number

    Offset from which nodes will be removed.

    howMany : number

    Number of nodes to remove.

    element : Element | DocumentFragment

    Element which children will be removed.

    Returns

    Array<Node>

    The array containing removed nodes.

    Related:

  • removeClass( className, element ) → void

    See source

    Removes specified class from the element.

    writer.removeClass( 'foo', linkElement );
writer.removeClass( [ 'foo', 'bar' ], linkElement );

    Parameters

    className : string | Array<string>

    Single class name or array of class names which will be removed.

    element : Element

    Element from which class will be removed.

    Returns

    void

    Related:

  • removeCustomProperty( key, element ) → boolean

    See source

    Removes a custom property stored under the given key.

    Parameters

    key : string | symbol

    Name/key of the custom property to be removed.

    element : Element | DocumentFragment

    Element from which the custom property will be removed.

    Returns

    boolean

    Returns true if property was removed.

    Related:

  • removeStyle( property, element ) → void

    See source

    Removes specified style from the element.

    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 a particular style processor rule is enabled. See StylesMap#remove() for details.

    Parameters

    property : string | Array<string>

    Style property name or names to be removed.

    element : Element

    Element from which style will be removed.

    Returns

    void

    Related:

  • rename( newName, element ) → null | Element

    See source

    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.

    Parameters

    newName : string

    New element name.

    element : Element

    Element to be renamed.

    Returns

    null | Element

    New element or null if the old element was not replaced (happens for detached elements).

  • replace( oldElement, newElement ) → boolean

    See source

    Replaces given element with the new one in the view structure. Will not have effect on detached elements.

    Parameters

    oldElement : Element

    Element which will be replaced.

    newElement : Element

    Element which will be inserted in the place of the old element.

    Returns

    boolean

    Whether old element was successfully replaced.

  • setAttribute( key, value, element ) → void

    See source

    Adds or overwrites element's attribute with a specified key and value.

    writer.setAttribute( 'href', 'http://ckeditor.com', linkElement );

    Parameters

    key : string

    Attribute key.

    value : unknown

    Attribute value.

    element : Element

    Element for which attribute will be set.

    Returns

    void

    Related:

  • setCustomProperty( key, value, element ) → void

    See source

    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.

    Parameters

    key : string | symbol

    Custom property name/key.

    value : unknown

    Custom property value to be stored.

    element : Element | DocumentFragment

    Element for which custom property will be set.

    Returns

    void

    Related:

  • setStyle( properties, element ) → void

    See source

    Adds style to the element.

    writer.setStyle( {
	color: 'red',
	position: 'fixed'
}, element );

    Note: This method can work with normalized style names if a particular style processor rule is enabled. See StylesMap#set() for details.

    Parameters

    properties : Record<string, string>

    Object with key - value pairs.

    element : Element

    Element for which style will be added.

    Returns

    void

    Related:

  • setStyle( property, value, element ) → void

    See source

    Adds style to the element.

    writer.setStyle( 'color', 'red', element );

    Note: This method can work with normalized style names if a particular style processor rule is enabled. See StylesMap#set() for details.

    Parameters

    property : string

    Property name.

    value : string

    Value to set.

    element : Element

    Element for which style will be added.

    Returns

    void

    Related:

  • unwrapElement( element ) → void

    See source

    Removes given element from view structure and places its children in its position. It does nothing if element has no parent.

    Parameters

    element : Element

    Element to unwrap.

    Returns

    void