Class: LexicalNode

lexical.LexicalNode

Hierarchy

• LexicalNode

  ↳ DecoratorNode

  ↳ ElementNode

  ↳ LineBreakNode

  ↳ TextNode

Indexable

▪ [x: string]: any

Constructors

constructor

• new LexicalNode(key?)

Parameters

Name	Type
key?	string

Defined in

lexical/src/LexicalNode.ts:187

Methods

createDOM

▸ createDOM(_config, _editor): HTMLElement

Parameters

Name	Type
_config	EditorConfig
_editor	LexicalEditor

Returns

HTMLElement

Defined in

lexical/src/LexicalNode.ts:594

---

exportDOM

▸ exportDOM(editor): DOMExportOutput

Parameters

Name	Type
editor	LexicalEditor

Returns

DOMExportOutput

Defined in

lexical/src/LexicalNode.ts:616

---

exportJSON

▸ exportJSON(): SerializedLexicalNode

Returns

SerializedLexicalNode

Defined in

lexical/src/LexicalNode.ts:621

---

getCommonAncestor

▸ getCommonAncestor<T>(node): null | T

Type parameters

Name	Type
T	extends ElementNode<T> = ElementNode

Parameters

Name	Type
node	LexicalNode

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:379

---

getIndexWithinParent

▸ getIndexWithinParent(): number

Returns

number

Defined in

lexical/src/LexicalNode.ts:263

---

getKey

▸ getKey(): string

Returns

string

Defined in

lexical/src/LexicalNode.ts:258

---

getLatest

▸ getLatest(): LexicalNode

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:526

---

getNextSibling

▸ getNextSibling<T>(): null | T

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:363

---

getNextSiblings

▸ getNextSiblings<T>(): T[]

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

T[]

Defined in

lexical/src/LexicalNode.ts:369

---

getNodesBetween

▸ getNodesBetween(targetNode): LexicalNode[]

Parameters

Name	Type
targetNode	LexicalNode

Returns

LexicalNode[]

Defined in

lexical/src/LexicalNode.ts:459

---

getParent

▸ getParent<T>(): null | T

Type parameters

Name	Type
T	extends ElementNode<T>

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:280

---

getParentKeys

▸ getParentKeys(): string[]

Returns

string[]

Defined in

lexical/src/LexicalNode.ts:330

---

getParentOrThrow

▸ getParentOrThrow<T>(): T

Type parameters

Name	Type
T	extends ElementNode<T>

Returns

T

Defined in

lexical/src/LexicalNode.ts:288

---

getParents

▸ getParents(): ElementNode[]

Returns

ElementNode[]

Defined in

lexical/src/LexicalNode.ts:320

---

getPreviousSibling

▸ getPreviousSibling<T>(): null | T

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:340

---

getPreviousSiblings

▸ getPreviousSiblings<T>(): T[]

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

T[]

Defined in

lexical/src/LexicalNode.ts:346

---

getTextContent

▸ getTextContent(): string

Returns

string

Defined in

lexical/src/LexicalNode.ts:584

---

getTextContentSize

▸ getTextContentSize(): number

Returns

number

Defined in

lexical/src/LexicalNode.ts:588

---

getTopLevelElement

▸ getTopLevelElement(): null | LexicalNode | ElementNode

Returns

null | LexicalNode | ElementNode

Defined in

lexical/src/LexicalNode.ts:296

---

getTopLevelElementOrThrow

▸ getTopLevelElementOrThrow(): LexicalNode | ElementNode

Returns

LexicalNode | ElementNode

Defined in

lexical/src/LexicalNode.ts:308

---

getType

▸ getType(): string

Returns

string

Defined in

lexical/src/LexicalNode.ts:208

---

getWritable

▸ getWritable(): LexicalNode

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:537

---

insertAfter

▸ insertAfter(nodeToInsert, restoreSelection?): LexicalNode

Parameters

Name	Type	Default value
nodeToInsert	LexicalNode	undefined
restoreSelection	boolean	true

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:696

---

insertBefore

▸ insertBefore(nodeToInsert, restoreSelection?): LexicalNode

Parameters

Name	Type	Default value
nodeToInsert	LexicalNode	undefined
restoreSelection	boolean	true

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:756

---

is

▸ is(object): boolean

Parameters

Name	Type
object	undefined | null | LexicalNode

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:405

---

isAttached

▸ isAttached(): boolean

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:212

---

isBefore

▸ isBefore(targetNode): boolean

Parameters

Name	Type
targetNode	LexicalNode

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:412

---

isDirty

▸ isDirty(): boolean

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:520

---

isParentOf

▸ isParentOf(targetNode): boolean

Parameters

Name	Type
targetNode	LexicalNode

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:443

---

isSelected

▸ isSelected(selection?): boolean

Parameters

Name	Type
selection?	null | RangeSelection | NodeSelection | GridSelection

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:229

---

markDirty

▸ markDirty(): void

Returns

void

Defined in

lexical/src/LexicalNode.ts:822

---

remove

▸ remove(preserveEmptyParent?): void

Parameters

Name	Type
preserveEmptyParent?	boolean

Returns

void

Defined in

lexical/src/LexicalNode.ts:635

---

replace

▸ replace<N>(replaceWith, includeChildren?): N

Type parameters

Name	Type
N	extends LexicalNode<N>

Parameters

Name	Type
replaceWith	N
includeChildren?	boolean

Returns

N

Defined in

lexical/src/LexicalNode.ts:639

---

selectNext

▸ selectNext(anchorOffset?, focusOffset?): RangeSelection

Parameters

Name	Type
anchorOffset?	number
focusOffset?	number

Returns

RangeSelection

Defined in

lexical/src/LexicalNode.ts:806

---

selectPrevious

▸ selectPrevious(anchorOffset?, focusOffset?): RangeSelection

Parameters

Name	Type
anchorOffset?	number
focusOffset?	number

Returns

RangeSelection

Defined in

lexical/src/LexicalNode.ts:790

---

updateDOM

▸ updateDOM(_prevNode, _dom, _config): boolean

Parameters

Name	Type
_prevNode	unknown
_dom	HTMLElement
_config	EditorConfig

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:608

---

clone

▸ Static clone(_data): LexicalNode

Parameters

Name	Type
_data	unknown

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:179

---

getType

▸ Static getType(): string

Returns

string

Defined in

lexical/src/LexicalNode.ts:171

---

importJSON

▸ Static importJSON(_serializedNode): LexicalNode

Parameters

Name	Type
_serializedNode	SerializedLexicalNode

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:625