Skip to main content

Class: ElementNode

lexical.ElementNode

Hierarchy

Constructors

constructor

new ElementNode(key?): ElementNode

Parameters

NameType
key?string

Returns

ElementNode

Overrides

LexicalNode.constructor

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:76

Properties

constructor

constructor: KlassConstructor<typeof ElementNode>

Overrides

LexicalNode.constructor

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:62

Methods

append

append(...nodesToAppend): this

Parameters

NameType
...nodesToAppendLexicalNode[]

Returns

this

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:348


canBeEmpty

canBeEmpty(): boolean

Returns

boolean

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:536


canIndent

canIndent(): boolean

Returns

boolean

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:514


canInsertTextAfter

canInsertTextAfter(): boolean

Returns

boolean

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:542


canInsertTextBefore

canInsertTextBefore(): boolean

Returns

boolean

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:539


clear

clear(): this

Returns

this

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:342


collapseAtStart

collapseAtStart(selection): boolean

Parameters

NameType
selectionRangeSelection

Returns

boolean

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:522


excludeFromCopy

excludeFromCopy(destination?): boolean

Parameters

NameType
destination?"clone" | "html"

Returns

boolean

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:525


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

packages/lexical/src/nodes/LexicalElementNode.ts:497


extractWithChild

extractWithChild(child, selection, destination): boolean

Parameters

NameType
childLexicalNode
selectionnull | BaseSelection
destination"clone" | "html"

Returns

boolean

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:559


getAllTextNodes

getAllTextNodes(): TextNode[]

Returns

TextNode[]

Defined in

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

packages/lexical/src/nodes/LexicalElementNode.ts:214


getChildren

getChildren<T>(): T[]

Type parameters

NameType
Textends LexicalNode

Returns

T[]

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:98


getChildrenKeys

getChildrenKeys(): string[]

Returns

string[]

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:107


getChildrenSize

getChildrenSize(): number

Returns

number

Defined in

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

packages/lexical/src/nodes/LexicalElementNode.ts:170


getDirection

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

Returns

null | "ltr" | "rtl"

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:275


getFirstChild

getFirstChild<T>(): null | T

Type parameters

NameType
Textends LexicalNode

Returns

null | T

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:190


getFirstChildOrThrow

getFirstChildOrThrow<T>(): T

Type parameters

NameType
Textends LexicalNode

Returns

T

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:195


getFirstDescendant

getFirstDescendant<T>(): null | T

Type parameters

NameType
Textends LexicalNode

Returns

null | T

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:148


getFormat

getFormat(): number

Returns

number

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:86


getFormatType

getFormatType(): ElementFormatType

Returns

ElementFormatType

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:90


getIndent

getIndent(): number

Returns

number

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:94


getLastChild

getLastChild<T>(): null | T

Type parameters

NameType
Textends LexicalNode

Returns

null | T

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:202


getLastChildOrThrow

getLastChildOrThrow<T>(): T

Type parameters

NameType
Textends LexicalNode

Returns

T

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:207


getLastDescendant

getLastDescendant<T>(): null | T

Type parameters

NameType
Textends LexicalNode

Returns

null | T

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:159


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

packages/lexical/src/nodes/LexicalElementNode.ts:241


getTextContentSize

getTextContentSize(): number

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

Returns

number

Overrides

LexicalNode.getTextContentSize

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:258


hasFormat

hasFormat(type): boolean

Parameters

NameType
typeElementFormatType

Returns

boolean

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:279


insertNewAfter

insertNewAfter(selection, restoreSelection?): null | LexicalNode

Parameters

NameType
selectionRangeSelection
restoreSelection?boolean

Returns

null | LexicalNode

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:508


isDirty

isDirty(): boolean

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

Returns

boolean

Overrides

LexicalNode.isDirty

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:123


isEmpty

isEmpty(): boolean

Returns

boolean

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:120


isInline

isInline(): boolean

Returns

boolean

Overrides

LexicalNode.isInline

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:545


isLastChild

isLastChild(): boolean

Returns

boolean

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:128


isShadowRoot

isShadowRoot(): boolean

Returns

boolean

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:552


select

select(_anchorOffset?, _focusOffset?): RangeSelection

Parameters

NameType
_anchorOffset?number
_focusOffset?number

Returns

RangeSelection

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:289


selectEnd

selectEnd(): RangeSelection

Returns

RangeSelection

Overrides

LexicalNode.selectEnd

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:338


selectStart

selectStart(): RangeSelection

Returns

RangeSelection

Overrides

LexicalNode.selectStart

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:334


setDirection

setDirection(direction): this

Parameters

NameType
directionnull | "ltr" | "rtl"

Returns

this

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:351


setFormat

setFormat(type): this

Parameters

NameType
typeElementFormatType

Returns

this

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:356


setIndent

setIndent(indentLevel): this

Parameters

NameType
indentLevelnumber

Returns

this

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:361


splice

splice(start, deleteCount, nodesToInsert): this

Parameters

NameType
startnumber
deleteCountnumber
nodesToInsertLexicalNode[]

Returns

this

Defined in

packages/lexical/src/nodes/LexicalElementNode.ts:366