Skip to main content

Class: ElementNode

lexical.ElementNode

Hierarchy

Constructors

constructor

new ElementNode(key?)

Parameters

NameType
key?string

Overrides

LexicalNode.constructor

Defined in

lexical/src/nodes/LexicalElementNode.ts:76

Methods

append

append(...nodesToAppend): ElementNode

Parameters

NameType
...nodesToAppendLexicalNode[]

Returns

ElementNode

Defined in

lexical/src/nodes/LexicalElementNode.ts:368


canBeEmpty

canBeEmpty(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:558


canExtractContents

canExtractContents(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:549


canIndent

canIndent(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:534


canInsertAfter

canInsertAfter(node): boolean

Parameters

NameType
nodeLexicalNode

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:555


canInsertTextAfter

canInsertTextAfter(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:564


canInsertTextBefore

canInsertTextBefore(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:561


canMergeWith

canMergeWith(node): boolean

Parameters

NameType
nodeElementNode

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:577


canReplaceWith

canReplaceWith(replacement): boolean

Parameters

NameType
replacementLexicalNode

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:552


clear

clear(): ElementNode

Returns

ElementNode

Defined in

lexical/src/nodes/LexicalElementNode.ts:362


collapseAtStart

collapseAtStart(selection): boolean

Parameters

NameType
selectionRangeSelection

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:542


excludeFromCopy

excludeFromCopy(destination?): boolean

Parameters

NameType
destination?"clone" | "html"

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:545


exportJSON

exportJSON(): SerializedElementNode<SerializedLexicalNode>

Controls how the this node is serialized to JSON. This is important for copy and paste between Lexical editors sharing the same namespace. It's also important if you're serializing to JSON for persistent storage somewhere. See Serialization & Deserialization.

Returns

SerializedElementNode<SerializedLexicalNode>

Overrides

LexicalNode.exportJSON

Defined in

lexical/src/nodes/LexicalElementNode.ts:517


extractWithChild

extractWithChild(child, selection, destination): boolean

Parameters

NameType
childLexicalNode
selectionnull | RangeSelection | NodeSelection | GridSelection
destination"clone" | "html"

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:580


getAllTextNodes

getAllTextNodes(): TextNode[]

Returns

TextNode[]

Defined in

lexical/src/nodes/LexicalElementNode.ts:133


getChildAtIndex

getChildAtIndex<T>(index): null | T

Type parameters

NameType
Textends LexicalNode

Parameters

NameType
indexnumber

Returns

null | T

Defined in

lexical/src/nodes/LexicalElementNode.ts:220


getChildren

getChildren<T>(): T[]

Type parameters

NameType
Textends LexicalNode

Returns

T[]

Defined in

lexical/src/nodes/LexicalElementNode.ts:98


getChildrenKeys

getChildrenKeys(): string[]

Returns

string[]

Defined in

lexical/src/nodes/LexicalElementNode.ts:107


getChildrenSize

getChildrenSize(): number

Returns

number

Defined in

lexical/src/nodes/LexicalElementNode.ts:116


getDescendantByIndex

getDescendantByIndex<T>(index): null | T

Type parameters

NameType
Textends LexicalNode

Parameters

NameType
indexnumber

Returns

null | T

Defined in

lexical/src/nodes/LexicalElementNode.ts:176


getDirection

getDirection(): null | "ltr" | "rtl"

Returns

null | "ltr" | "rtl"

Defined in

lexical/src/nodes/LexicalElementNode.ts:281


getFirstChild

getFirstChild<T>(): null | T

Type parameters

NameType
Textends LexicalNode

Returns

null | T

Defined in

lexical/src/nodes/LexicalElementNode.ts:196


getFirstChildOrThrow

getFirstChildOrThrow<T>(): T

Type parameters

NameType
Textends LexicalNode

Returns

T

Defined in

lexical/src/nodes/LexicalElementNode.ts:201


getFirstDescendant

getFirstDescendant<T>(): null | T

Type parameters

NameType
Textends LexicalNode

Returns

null | T

Defined in

lexical/src/nodes/LexicalElementNode.ts:148


getFormat

getFormat(): number

Returns

number

Defined in

lexical/src/nodes/LexicalElementNode.ts:86


getFormatType

getFormatType(): ElementFormatType

Returns

ElementFormatType

Defined in

lexical/src/nodes/LexicalElementNode.ts:90


getIndent

getIndent(): number

Returns

number

Defined in

lexical/src/nodes/LexicalElementNode.ts:94


getLastChild

getLastChild<T>(): null | T

Type parameters

NameType
Textends LexicalNode

Returns

null | T

Defined in

lexical/src/nodes/LexicalElementNode.ts:208


getLastChildOrThrow

getLastChildOrThrow<T>(): T

Type parameters

NameType
Textends LexicalNode

Returns

T

Defined in

lexical/src/nodes/LexicalElementNode.ts:213


getLastDescendant

getLastDescendant<T>(): null | T

Type parameters

NameType
Textends LexicalNode

Returns

null | T

Defined in

lexical/src/nodes/LexicalElementNode.ts:162


getTextContent

getTextContent(): string

Returns the text content of the node. Override this for custom nodes that should have a representation in plain text format (for copy + paste, for example)

Returns

string

Overrides

LexicalNode.getTextContent

Defined in

lexical/src/nodes/LexicalElementNode.ts:247


getTextContentSize

getTextContentSize(): number

Returns the length of the string produced by calling getTextContent on this node.

Returns

number

Overrides

LexicalNode.getTextContentSize

Defined in

lexical/src/nodes/LexicalElementNode.ts:264


hasFormat

hasFormat(type): boolean

Parameters

NameType
typeElementFormatType

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:285


insertNewAfter

insertNewAfter(selection, restoreSelection?): null | LexicalNode

Parameters

NameType
selectionRangeSelection
restoreSelection?boolean

Returns

null | LexicalNode

Defined in

lexical/src/nodes/LexicalElementNode.ts:528


isDirty

isDirty(): boolean

Returns true if this node has been marked dirty during this update cycle.

Returns

boolean

Overrides

LexicalNode.isDirty

Defined in

lexical/src/nodes/LexicalElementNode.ts:123


isEmpty

isEmpty(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:120


isInline

isInline(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:567


isLastChild

isLastChild(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:128


isShadowRoot

isShadowRoot(): boolean

Returns

boolean

Defined in

lexical/src/nodes/LexicalElementNode.ts:574


select

select(_anchorOffset?, _focusOffset?): RangeSelection

Parameters

NameType
_anchorOffset?number
_focusOffset?number

Returns

RangeSelection

Defined in

lexical/src/nodes/LexicalElementNode.ts:295


selectEnd

selectEnd(): RangeSelection

Returns

RangeSelection

Defined in

lexical/src/nodes/LexicalElementNode.ts:351


selectStart

selectStart(): RangeSelection

Returns

RangeSelection

Defined in

lexical/src/nodes/LexicalElementNode.ts:340


setDirection

setDirection(direction): ElementNode

Parameters

NameType
directionnull | "ltr" | "rtl"

Returns

ElementNode

Defined in

lexical/src/nodes/LexicalElementNode.ts:371


setFormat

setFormat(type): ElementNode

Parameters

NameType
typeElementFormatType

Returns

ElementNode

Defined in

lexical/src/nodes/LexicalElementNode.ts:376


setIndent

setIndent(indentLevel): ElementNode

Parameters

NameType
indentLevelnumber

Returns

ElementNode

Defined in

lexical/src/nodes/LexicalElementNode.ts:381


splice

splice(start, deleteCount, nodesToInsert): ElementNode

Parameters

NameType
startnumber
deleteCountnumber
nodesToInsertLexicalNode[]

Returns

ElementNode

Defined in

lexical/src/nodes/LexicalElementNode.ts:386