CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Class

Element (engine/view)

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

class
See source

View element.

The editing engine does not define a fixed semantics of its elements (it is "DTD-free"). This is why the type of the Element need to be defined by the feature developer. When creating an element you should use one of the following methods:

Note that for view elements which are not created from the model, like elements from mutations, paste or data.set it is not possible to define the type of the element. In such cases the UpcastWriter#createElement() method should be used to create generic view elements.

Filtering

Properties

  • readonly

    childCount : Number

    See source

    Number of element's children.

  • readonly inherited

    document : Document

    See source

    The document instance to which this node belongs.

  • readonly inherited

    index : Number | null

    See source

    Index of the node in the parent element or null if the node has no parent.

    Accessing this property throws an error if this node's parent element does not contain it. This means that view tree got broken.

  • readonly

    isEmpty : Boolean

    See source

    Is true if there are no nodes inside this element, false otherwise.

  • readonly

    name : String

    See source

    Name of the element.

  • readonly inherited

    nextSibling : Node | null

    See source

    Node's next sibling, or null if it is the last child.

  • readonly inherited

    parent : Element | DocumentFragment | null

    See source

    Parent element. Null by default. Set by _insertChild.

  • readonly inherited

    previousSibling : Node | null

    See source

    Node's previous sibling, or null if it is the first child.

  • readonly inherited

    root : Node | DocumentFragment

    See source

    Top-most ancestor of the node. If the node has no parent it is the root itself.

  • protected

    _attrs : Map

    See source

    Map of attributes, where attributes names are keys and attributes values are values.

  • protected

    _children : Array.<Node>

    See source

    Array of child nodes.

  • protected

    _classes : Set

    See source

    Set of classes associated with element instance.

  • protected

    _customProperties : Map

    See source

    Map of custom properties. Custom properties can be added to element instance, will be cloned but not rendered into DOM.

  • protected

    _styles : StylesMap

    See source

    Normalized styles.

  • private readonly

    _unsafeAttributesToRender : Array.<String>

    See source

    A list of attribute names that should be rendered in the editing pipeline even though filtering mechanisms implemented in the DomConverter (for instance, shouldRenderAttribute) would filter them out.

    These attributes can be specified as an option when the element is created by the DowncastWriter. To check whether an unsafe an attribute should be permitted, use the shouldRenderUnsafeAttribute method.

Methods

  • protected

    constructor( document, name, [ attrs ], [ children ] )

    See source

    Creates a view element.

    Attributes can be passed in various formats:

    new Element( viewDocument, 'div', { class: 'editor', contentEditable: 'true' } ); // object
new Element( viewDocument, 'div', [ [ 'class', 'editor' ], [ 'contentEditable', 'true' ] ] ); // map-like iterator
new Element( viewDocument, 'div', mapOfAttributes ); // map

    Parameters

    document : Document

    The document instance to which this element belongs.

    name : String

    Node name.

    [ attrs ] : Object | Iterable

    Collection of attributes.

    [ children ] : Node | Iterable.<Node>

    A list of nodes to be inserted into created element.

  • findAncestor( patterns ) → Element | null

    See source

    Returns ancestor element that match specified pattern. Provided patterns should be compatible with Matcher as it is used internally.

    Parameters

    patterns : Object | String | RegExp | function

    Patterns used to match correct ancestor. See Matcher.

    Returns

    Element | null

    Found element or null if no matching ancestor was found.

    Related:

  • inherited

    getAncestors( options = { [options.includeSelf], [options.parentFirst] } ) → Array

    See source

    Returns ancestors array of this node.

    Parameters

    options : Object

    Options object.

    Properties
    [ options.includeSelf ] : Boolean

    When set to true this node will be also included in parent's array.

    Defaults to false

    [ options.parentFirst ] : Boolean

    When set to true, array will be sorted from node's parent to root element, otherwise root element will be the first item in the array.

    Defaults to false

    Returns

    Array

    Array with ancestors.

  • getAttribute( key ) → String | undefined

    See source

    Gets attribute by key. If attribute is not present - returns undefined.

    Parameters

    key : String

    Attribute key.

    Returns

    String | undefined

    Attribute value.

  • getAttributeKeys() → Iterable.<String>

    See source

    Returns an iterator that contains the keys for attributes. Order of inserting attributes is not preserved.

    Returns

    Iterable.<String>

    Keys for attributes.

  • getAttributes() → Iterable.<*>

    See source

    Returns iterator that iterates over this element's attributes.

    Attributes are returned as arrays containing two items. First one is attribute key and second is attribute value. This format is accepted by native Map object and also can be passed in Node constructor.

    Returns

    Iterable.<*>

  • getChild( index ) → Node

    See source

    Gets child at the given index.

    Parameters

    index : Number

    Index of child.

    Returns

    Node

    Child node.

  • getChildIndex( node ) → Number

    See source

    Gets index of the given child node. Returns -1 if child node is not found.

    Parameters

    node : Node

    Child node.

    Returns

    Number

    Index of the child node.

  • getChildren() → Iterable.<Node>

    See source

    Gets child nodes iterator.

    Returns

    Iterable.<Node>

    Child nodes iterator.

  • getClassNames() → Iterable.<String>

    See source

    Returns iterator that contains all class names.

    Returns

    Iterable.<String>

  • inherited

    getCommonAncestor( node, options = { [options.includeSelf] } ) → Element | DocumentFragment | null

    See source

    Returns a Element or DocumentFragment which is a common ancestor of both nodes.

    Parameters

    node : Node

    The second node.

    options : Object

    Options object.

    Properties
    [ options.includeSelf ] : Boolean

    When set to true both nodes will be considered "ancestors" too. Which means that if e.g. node A is inside B, then their common ancestor will be B.

    Defaults to false

    Returns

    Element | DocumentFragment | null

  • getCustomProperties() → Iterable.<*>

    See source

    Returns an iterator which iterates over this element's custom properties. Iterator provides [ key, value ] pairs for each stored property.

    Returns

    Iterable.<*>

  • getCustomProperty( key ) → *

    See source

    Returns the custom property value for the given key.

    Parameters

    key : String | Symbol

    Returns

    *

  • getFillerOffset()

    See source

    Returns block filler offset or null if block filler is not needed.

  • getIdentity() → String

    See source

    Returns identity string based on element's name, styles, classes and other attributes. Two elements that are similar will have same identity string. It has the following format:

    'name class="class1,class2" style="style1:value1;style2:value2" attr1="val1" attr2="val2"'

    For example:

    const element = writer.createContainerElement( 'foo', {
	banana: '10',
	apple: '20',
	style: 'color: red; border-color: white;',
	class: 'baz'
} );

// returns 'foo class="baz" style="border-color:white;color:red" apple="20" banana="10"'
element.getIdentity();

    Note: Classes, styles and other attributes are sorted alphabetically.

    Returns

    String

  • getNormalizedStyle( property ) → Object | String | undefined

    See source

    Returns a normalized style object or single style value.

    For an element with style set to: margin:1px 2px 3em;

    element.getNormalizedStyle( 'margin' ) );

    will return:

    {
	top: '1px',
	right: '2px',
	bottom: '3em',
	left: '2px'    // a normalized value from margin shorthand
}

    and reading for single style value:

    styles.getNormalizedStyle( 'margin-left' );

    Will return a 2px string.

    Note: This method will return normalized values only if a particular style processor rule is enabled. See StylesMap#getNormalized() for details.

    Parameters

    property : String

    Name of CSS property

    Returns

    Object | String | undefined

  • inherited

    getPath() → Array.<Number>

    See source

    Gets a path to the node. The path is an array containing indices of consecutive ancestors of this node, beginning from root, down to this node's index.

    const abc = downcastWriter.createText( 'abc' );
const foo = downcastWriter.createText( 'foo' );
const h1 = downcastWriter.createElement( 'h1', null, downcastWriter.createText( 'header' ) );
const p = downcastWriter.createElement( 'p', null, [ abc, foo ] );
const div = downcastWriter.createElement( 'div', null, [ h1, p ] );
foo.getPath(); // Returns [ 1, 3 ]. `foo` is in `p` which is in `div`. `p` starts at offset 1, while `foo` at 3.
h1.getPath(); // Returns [ 0 ].
div.getPath(); // Returns [].

    Returns

    Array.<Number>

    The path.

  • getStyle( property ) → String | undefined

    See source

    Returns style value for the given property mae. If the style does not exist undefined is returned.

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

    For an element with style set to 'margin:1px':

    // Enable 'margin' shorthand processing:
editor.data.addStyleProcessorRules( addMarginRules );

const element = view.change( writer => {
	const element = writer.createElement();
	writer.setStyle( 'margin', '1px' );
	writer.setStyle( 'margin-bottom', '3em' );

	return element;
} );

element.getStyle( 'margin' ); // -> 'margin: 1px 1px 3em;'

    Parameters

    property : String

    Returns

    String | undefined

  • getStyleNames( [ expand ] ) → Iterable.<String>

    See source

    Returns iterator that contains all style names.

    Parameters

    [ expand ] : Boolean

    Expand shorthand style properties and return all equivalent style representations.

    Defaults to false

    Returns

    Iterable.<String>

  • hasAttribute( key ) → Boolean

    See source

    Returns a boolean indicating whether an attribute with the specified key exists in the element.

    Parameters

    key : String

    Attribute key.

    Returns

    Boolean

    true if attribute with the specified key exists in the element, false otherwise.

  • hasClass( className )

    See source

    Returns true if class is present. If more then one class is provided - returns true only when all classes are present.

    element.hasClass( 'foo' ); // Returns true if 'foo' class is present.
element.hasClass( 'foo', 'bar' ); // Returns true if 'foo' and 'bar' classes are both present.

    Parameters

    className : String

  • hasStyle( property )

    See source

    Returns true if style keys are present. If more then one style property is provided - returns true only when all properties are present.

    element.hasStyle( 'color' ); // Returns true if 'border-top' style is present.
element.hasStyle( 'color', 'border-top' ); // Returns true if 'color' and 'border-top' styles are both present.

    Parameters

    property : String

  • is( type, [ name ] ) → Boolean

    See source

    Checks whether this object is of the given.

    element.is( 'element' ); // -> true
element.is( 'node' ); // -> true
element.is( 'view:element' ); // -> true
element.is( 'view:node' ); // -> true

element.is( 'model:element' ); // -> false
element.is( 'documentSelection' ); // -> false

    Assuming that the object being checked is an element, you can also check its name:

    element.is( 'element', 'img' ); // -> true if this is an <img> element
text.is( 'element', 'img' ); -> false

    Check the entire list of view objects which implement the is() method.

    Parameters

    type : String

    Type to check.

    [ name ] : String

    Element name.

    Returns

    Boolean

  • inherited

    isAfter( node ) → Boolean

    See source

    Returns whether this node is after given node. false is returned if nodes are in different trees (for example, in different DocumentFragments).

    Parameters

    node : Node

    Node to compare with.

    Returns

    Boolean

  • inherited

    isAttached() → Boolean

    See source

    Returns true if the node is in a tree rooted in the document (is a descendant of one of its roots).

    Returns

    Boolean

  • inherited

    isBefore( node ) → Boolean

    See source

    Returns whether this node is before given node. false is returned if nodes are in different trees (for example, in different DocumentFragments).

    Parameters

    node : Node

    Node to compare with.

    Returns

    Boolean

  • isSimilar( otherElement ) → Boolean

    See source

    Checks if this element is similar to other element. Both elements should have the same name and attributes to be considered as similar. Two similar elements can contain different set of children nodes.

    Parameters

    otherElement : Element

    Returns

    Boolean

  • shouldRenderUnsafeAttribute( attributeName ) → Boolean

    See source

    Decides whether an unsafe attribute is whitelisted and should be rendered in the editing pipeline even though filtering mechanisms like shouldRenderAttribute say it should not.

    Unsafe attribute names can be specified when creating an element via DowncastWriter.

    Parameters

    attributeName : String

    The name of the attribute to be checked.

    Returns

    Boolean

  • inherited

    toJSON() → Object

    See source

    Custom toJSON method to solve child-parent circular dependencies.

    Returns

    Object

    Clone of this object with the parent property removed.

  • protected

    _addClass( className )

    See source

    Adds specified class.

    element._addClass( 'foo' ); // Adds 'foo' class.
element._addClass( [ 'foo', 'bar' ] ); // Adds 'foo' and 'bar' classes.

    Parameters

    className : Array.<String> | String

    Fires

    Related:

  • protected

    _appendChild( items ) → Number

    See source

    Insert 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 : Item | Iterable.<Item>

    Items to be inserted.

    Returns

    Number

    Number of appended nodes.

    Fires

    Related:

  • protected

    _clone( [ deep ] ) → Element

    See source

    Clones provided element.

    Parameters

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

  • protected inherited

    _fireChange( type, node )

    See source

    Parameters

    type : ChangeType

    Type of the change.

    node : Node

    Changed node.

    Fires

  • protected

    _insertChild( index, items ) → 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

    Position where nodes should be inserted.

    items : Item | Iterable.<Item>

    Items to be inserted.

    Returns

    Number

    Number of inserted nodes.

    Fires

    Related:

  • protected inherited

    _remove()

    See source

    Removes node from parent.

  • protected

    _removeAttribute( key ) → Boolean

    See source

    Removes attribute from the element.

    Parameters

    key : String

    Attribute key.

    Returns

    Boolean

    Returns true if an attribute existed and has been removed.

    Fires

    Related:

  • protected

    _removeChildren( index, [ howMany ] ) → Array.<Node>

    See source

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

    Parameters

    index : Number

    Number of the first node to remove.

    [ howMany ] : Number

    Number of nodes to remove.

    Defaults to 1

    Returns

    Array.<Node>

    The array of removed nodes.

    Fires

    Related:

  • protected

    _removeClass( className )

    See source

    Removes specified class.

    element._removeClass( 'foo' );  // Removes 'foo' class.
element._removeClass( [ 'foo', 'bar' ] ); // Removes both 'foo' and 'bar' classes.

    Parameters

    className : Array.<String> | String

    Fires

    Related:

  • protected

    _removeCustomProperty( key ) → Boolean

    See source

    Removes the custom property stored under the given key.

    Parameters

    key : String | Symbol

    Returns

    Boolean

    Returns true if property was removed.

    Related:

  • protected

    _removeStyle( property )

    See source

    Removes specified style.

    element._removeStyle( 'color' );  // Removes 'color' style.
element._removeStyle( [ '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

    Fires

    Related:

  • protected

    _setAttribute( key, value )

    See source

    Adds or overwrite attribute with a specified key and value.

    Parameters

    key : String

    Attribute key.

    value : String

    Attribute value.

    Fires

    Related:

  • protected

    _setCustomProperty( key, value )

    See source

    Sets a custom property. 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
    value : *

    Related:

  • protected

    _setStyle( property, [ value ] )

    See source

    Adds style to the element.

    element._setStyle( 'color', 'red' );
element._setStyle( {
	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.

    Fires

    Related:

Events

  • inherited

    change( eventInfo )

    See source

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

  • inherited

    change:attributes( eventInfo, changedNode )

    See source

    Fired when list of elements attributes changes.

    Change event is bubbled – it is fired on all ancestors.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    changedNode : Node

  • inherited

    change:children( eventInfo, changedNode )

    See source

    Fired when list of elements children changes.

    Change event is bubbled – it is fired on all ancestors.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    changedNode : Node

  • inherited

    change:text( eventInfo, changedNode )

    See source

    Fired when text nodes data changes.

    Change event is bubbled – it is fired on all ancestors.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    changedNode : Node