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

  • document : Document

    readonly

    The view document instance in which this upcast writer operates.

    See source

Methods

  • constructor( document )

    Parameters

    document : Document

    The view document instance in which this upcast writer operates.

  • addClass( className, element )

    Adds specified class to the element.

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

    Parameters

    className : Array.<String> | String

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

    element : Element

    Element for which class will be added.

    Related:

  • appendChild( items, element ) → Number

    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 source

    Parameters

    items : Item | Iterable.<Item>

    Items to be inserted.

    element : Element | DocumentFragment

    Element to which items will be appended.

    Returns

    Number

    Number of appended nodes.

    Fires

    Related:

  • clone( element, [ deep ] ) → Element

    Clones the provided element.

    See source

    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

    Creates a new DocumentFragment instance.

    See source

    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

    Creates a new Element instance.

    See source

    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 ] : Object | Iterable

    Collection of attributes.

    [ children ] : Node | Iterable.<Node>

    A list of nodes to be inserted into created element.

    Returns

    Element

    Created element.

  • createPositionAfter( item ) → Position

    Creates a new position after given view item.

    See source

    Parameters

    item : Item

    View item after which the position should be located.

    Returns

    Position

  • createPositionAt( itemOrPosition, [ offset ] )

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

    See source
    • 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 : Item | Position
    [ offset ] : Number | 'end' | 'before' | 'after'

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

  • createPositionBefore( item ) → Position

    Creates a new position before given view item.

    See source

    Parameters

    item : Item

    View item before which the position should be located.

    Returns

    Position

  • createRange( start, [ end ] ) → Range

    Creates a range spanning from start position to end position.

    See source

    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

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

    See source

    Parameters

    element : Element

    Element which is a parent for the range.

    Returns

    Range

  • createRangeOn( item ) → Range

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

    See source

    Parameters

    item : Item

    Returns

    Range

  • createSelection( [ selectable ], [ placeOrOffset ], [ options ] = { [options.backward], [options.fake], [options.label] } ) → Selection

    Creates a new Selection instance.

    See source
    // 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 );

// 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( 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' } );

    Parameters

    [ selectable ] : Selectable
    [ placeOrOffset ] : Number | 'before' | 'end' | 'after' | 'on' | 'in'

    Offset or place when selectable is an Item.

    [ options ] : Object
    Properties
    [ options.backward ] : Boolean

    Sets this selection instance to be backward.

    [ options.fake ] : Boolean

    Sets this selection instance to be marked as fake.

    [ options.label ] : String

    Label for the fake selection.

    Returns

    Selection

  • createText( data ) → Text

    Creates a new Text instance.

    See source

    Parameters

    data : String

    The text's data.

    Returns

    Text

    The created text node.

  • insertChild( index, items, element ) → 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 source

    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.

    Fires

    Related:

  • remove( element ) → Array.<Node>

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

    See source

    Parameters

    element : Element

    Element which will be removed.

    Returns

    Array.<Node>

    The array containing removed nodes.

  • removeAttribute( key, element )

    Removes attribute from the element.

    See source
    writer.removeAttribute( linkElement, 'href' );

    Parameters

    key : String

    Attribute key.

    element : Element

    Element from which attribute will be removed.

    Related:

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

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

    See source

    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.

    Fires

    Related:

  • removeClass( className, element )

    Removes specified class from the element.

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

    Parameters

    className : Array.<String> | String

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

    element : Element

    Element from which class will be removed.

    Related:

  • removeCustomProperty( key, element ) → Boolean

    Removes a custom property stored under the given key.

    See source

    Parameters

    key : String | Symbol

    Name/key of the custom property to be removed.

    element : Element

    Element from which the custom property will be removed.

    Returns

    Boolean

    Returns true if property was removed.

    Related:

  • removeStyle( property, element )

    Removes specified style from the element.

    See source
    writer.removeStyle( element, 'color' );  // Removes 'color' style.
writer.removeStyle( element, [ 'color', 'border-top' ] ); // 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 : Array.<String> | String

    Style property name or names to be removed.

    element : Element

    Element from which style will be removed.

    Related:

  • rename( newName, element ) → Element | null

    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.

    See source

    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

    Element | null

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

  • replace( oldElement, newElement ) → Boolean

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

    See source

    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 )

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

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

    Parameters

    key : String

    Attribute key.

    value : String

    Attribute value.

    element : Element

    Element for which attribute will be set.

    Related:

  • setCustomProperty( key, value, element )

    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 source

    Parameters

    key : String | Symbol

    Custom property name/key.

    value : *

    Custom property value to be stored.

    element : Element

    Element for which custom property will be set.

    Related:

  • setStyle( property, [ value ], element )

    Adds style to the element.

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

    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 | Object

    Property name or object with key - value pairs.

    [ value ] : String

    Value to set. This parameter is ignored if object is provided as the first parameter.

    element : Element

    Element for which style will be added.

    Related:

  • unwrapElement( element )

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

    See source

    Parameters

    element : Element

    Element to unwrap.