Skip to main content

Class: LexicalNode

lexical.LexicalNode

Hierarchy

Indexable

[x: string]: any

Constructors

constructor

new LexicalNode(key?)

Parameters

NameType
key?string

Defined in

lexical/src/LexicalNode.ts:196

Methods

createDOM

createDOM(_config, _editor): HTMLElement

Parameters

NameType
_configEditorConfig
_editorLexicalEditor

Returns

HTMLElement

Defined in

lexical/src/LexicalNode.ts:596


exportDOM

exportDOM(editor): DOMExportOutput

Parameters

NameType
editorLexicalEditor

Returns

DOMExportOutput

Defined in

lexical/src/LexicalNode.ts:608


exportJSON

exportJSON(): SerializedLexicalNode

Returns

SerializedLexicalNode

Defined in

lexical/src/LexicalNode.ts:613


getCommonAncestor

getCommonAncestor<T>(node): null | T

Type parameters

NameType
Textends ElementNode<T> = ElementNode

Parameters

NameType
nodeLexicalNode

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:386


getIndexWithinParent

getIndexWithinParent(): number

Returns

number

Defined in

lexical/src/LexicalNode.ts:266


getKey

getKey(): string

Returns

string

Defined in

lexical/src/LexicalNode.ts:261


getLatest

getLatest(): LexicalNode

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:532


getNextSibling

getNextSibling<T>(): null | T

Type parameters

NameType
Textends LexicalNode<T>

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:360


getNextSiblings

getNextSiblings<T>(): T[]

Type parameters

NameType
Textends LexicalNode<T>

Returns

T[]

Defined in

lexical/src/LexicalNode.ts:374


getNodesBetween

getNodesBetween(targetNode): LexicalNode[]

Parameters

NameType
targetNodeLexicalNode

Returns

LexicalNode[]

Defined in

lexical/src/LexicalNode.ts:465


getParent

getParent<T>(): null | T

Type parameters

NameType
Textends ElementNode<T>

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:275


getParentKeys

getParentKeys(): string[]

Returns

string[]

Defined in

lexical/src/LexicalNode.ts:325


getParentOrThrow

getParentOrThrow<T>(): T

Type parameters

NameType
Textends ElementNode<T>

Returns

T

Defined in

lexical/src/LexicalNode.ts:283


getParents

getParents(): ElementNode[]

Returns

ElementNode[]

Defined in

lexical/src/LexicalNode.ts:315


getPreviousSibling

getPreviousSibling<T>(): null | T

Type parameters

NameType
Textends LexicalNode<T>

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:335


getPreviousSiblings

getPreviousSiblings<T>(): T[]

Type parameters

NameType
Textends LexicalNode<T>

Returns

T[]

Defined in

lexical/src/LexicalNode.ts:348


getTextContent

getTextContent(): string

Returns

string

Defined in

lexical/src/LexicalNode.ts:586


getTextContentSize

getTextContentSize(): number

Returns

number

Defined in

lexical/src/LexicalNode.ts:590


getTopLevelElement

getTopLevelElement(): null | LexicalNode | ElementNode

Returns

null | LexicalNode | ElementNode

Defined in

lexical/src/LexicalNode.ts:291


getTopLevelElementOrThrow

getTopLevelElementOrThrow(): LexicalNode | ElementNode

Returns

LexicalNode | ElementNode

Defined in

lexical/src/LexicalNode.ts:303


getType

getType(): string

Returns

string

Defined in

lexical/src/LexicalNode.ts:215


getWritable

getWritable(): LexicalNode

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:543


insertAfter

insertAfter(nodeToInsert): LexicalNode

Parameters

NameType
nodeToInsertLexicalNode

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:665


insertBefore

insertBefore(nodeToInsert): LexicalNode

Parameters

NameType
nodeToInsertLexicalNode

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:717


is

is(object): boolean

Parameters

NameType
objectundefined | null | LexicalNode

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:412


isAttached

isAttached(): boolean

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:219


isBefore

isBefore(targetNode): boolean

Parameters

NameType
targetNodeLexicalNode

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:419


isDirty

isDirty(): boolean

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:526


isParentOf

isParentOf(targetNode): boolean

Parameters

NameType
targetNodeLexicalNode

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:450


isSelected

isSelected(): boolean

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:236


markDirty

markDirty(): void

Returns

void

Defined in

lexical/src/LexicalNode.ts:774


remove

remove(preserveEmptyParent?): void

Parameters

NameType
preserveEmptyParent?boolean

Returns

void

Defined in

lexical/src/LexicalNode.ts:627


replace

replace<N>(replaceWith): N

Type parameters

NameType
Nextends LexicalNode<N>

Parameters

NameType
replaceWithN

Returns

N

Defined in

lexical/src/LexicalNode.ts:631


selectNext

selectNext(anchorOffset?, focusOffset?): RangeSelection

Parameters

NameType
anchorOffset?number
focusOffset?number

Returns

RangeSelection

Defined in

lexical/src/LexicalNode.ts:758


selectPrevious

selectPrevious(anchorOffset?, focusOffset?): RangeSelection

Parameters

NameType
anchorOffset?number
focusOffset?number

Returns

RangeSelection

Defined in

lexical/src/LexicalNode.ts:742


updateDOM

updateDOM(_prevNode, _dom, _config): boolean

Parameters

NameType
_prevNodeunknown
_domHTMLElement
_configEditorConfig

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:600


clone

Static clone(_data): LexicalNode

Parameters

NameType
_dataunknown

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:188


getType

Static getType(): string

Returns

string

Defined in

lexical/src/LexicalNode.ts:180


importJSON

Static importJSON(_serializedNode): LexicalNode

Parameters

NameType
_serializedNodeSerializedLexicalNode

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:617