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:193

Methods

createDOM

▸ createDOM(_config, _editor): HTMLElement

Parameters

Name	Type
_config	EditorConfig
_editor	LexicalEditor

Returns

HTMLElement

Defined in

lexical/src/LexicalNode.ts:600

---

createParentElementNode

▸ createParentElementNode(): ElementNode

Returns

ElementNode

Defined in

lexical/src/LexicalNode.ts:792

---

exportDOM

▸ exportDOM(editor): DOMExportOutput

Parameters

Name	Type
editor	LexicalEditor

Returns

DOMExportOutput

Defined in

lexical/src/LexicalNode.ts:622

---

exportJSON

▸ exportJSON(): SerializedLexicalNode

Returns

SerializedLexicalNode

Defined in

lexical/src/LexicalNode.ts:627

---

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:385

---

getIndexWithinParent

▸ getIndexWithinParent(): number

Returns

number

Defined in

lexical/src/LexicalNode.ts:269

---

getKey

▸ getKey(): string

Returns

string

Defined in

lexical/src/LexicalNode.ts:264

---

getLatest

▸ getLatest(): LexicalNode

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:532

---

getNextSibling

▸ getNextSibling<T>(): null | T

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:369

---

getNextSiblings

▸ getNextSiblings<T>(): T[]

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

T[]

Defined in

lexical/src/LexicalNode.ts:375

---

getNodesBetween

▸ getNodesBetween(targetNode): LexicalNode[]

Parameters

Name	Type
targetNode	LexicalNode

Returns

LexicalNode[]

Defined in

lexical/src/LexicalNode.ts:465

---

getParent

▸ getParent<T>(): null | T

Type parameters

Name	Type
T	extends ElementNode<T>

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:286

---

getParentKeys

▸ getParentKeys(): string[]

Returns

string[]

Defined in

lexical/src/LexicalNode.ts:336

---

getParentOrThrow

▸ getParentOrThrow<T>(): T

Type parameters

Name	Type
T	extends ElementNode<T>

Returns

T

Defined in

lexical/src/LexicalNode.ts:294

---

getParents

▸ getParents(): ElementNode[]

Returns

ElementNode[]

Defined in

lexical/src/LexicalNode.ts:326

---

getPreviousSibling

▸ getPreviousSibling<T>(): null | T

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:346

---

getPreviousSiblings

▸ getPreviousSiblings<T>(): T[]

Type parameters

Name	Type
T	extends LexicalNode<T>

Returns

T[]

Defined in

lexical/src/LexicalNode.ts:352

---

getTextContent

▸ getTextContent(): string

Returns

string

Defined in

lexical/src/LexicalNode.ts:590

---

getTextContentSize

▸ getTextContentSize(): number

Returns

number

Defined in

lexical/src/LexicalNode.ts:594

---

getTopLevelElement

▸ getTopLevelElement(): null | LexicalNode | ElementNode

Returns

null | LexicalNode | ElementNode

Defined in

lexical/src/LexicalNode.ts:302

---

getTopLevelElementOrThrow

▸ getTopLevelElementOrThrow(): LexicalNode | ElementNode

Returns

LexicalNode | ElementNode

Defined in

lexical/src/LexicalNode.ts:314

---

getType

▸ getType(): string

Returns

string

Defined in

lexical/src/LexicalNode.ts:214

---

getWritable

▸ getWritable(): LexicalNode

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:543

---

insertAfter

▸ insertAfter(nodeToInsert, restoreSelection?): LexicalNode

Parameters

Name	Type	Default value
nodeToInsert	LexicalNode	undefined
restoreSelection	boolean	true

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:694

---

insertBefore

▸ insertBefore(nodeToInsert, restoreSelection?): LexicalNode

Parameters

Name	Type	Default value
nodeToInsert	LexicalNode	undefined
restoreSelection	boolean	true

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:754

---

is

▸ is(object): boolean

Parameters

Name	Type
object	undefined | null | LexicalNode

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:411

---

isAttached

▸ isAttached(): boolean

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:218

---

isBefore

▸ isBefore(targetNode): boolean

Parameters

Name	Type
targetNode	LexicalNode

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:418

---

isDirty

▸ isDirty(): boolean

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:526

---

isParentOf

▸ isParentOf(targetNode): boolean

Parameters

Name	Type
targetNode	LexicalNode

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:449

---

isParentRequired

▸ isParentRequired(): boolean

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:788

---

isSelected

▸ isSelected(selection?): boolean

Parameters

Name	Type
selection?	null | RangeSelection | NodeSelection | GridSelection

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:235

---

markDirty

▸ markDirty(): void

Returns

void

Defined in

lexical/src/LexicalNode.ts:828

---

remove

▸ remove(preserveEmptyParent?): void

Parameters

Name	Type
preserveEmptyParent?	boolean

Returns

void

Defined in

lexical/src/LexicalNode.ts:633

---

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:637

---

selectNext

▸ selectNext(anchorOffset?, focusOffset?): RangeSelection

Parameters

Name	Type
anchorOffset?	number
focusOffset?	number

Returns

RangeSelection

Defined in

lexical/src/LexicalNode.ts:812

---

selectPrevious

▸ selectPrevious(anchorOffset?, focusOffset?): RangeSelection

Parameters

Name	Type
anchorOffset?	number
focusOffset?	number

Returns

RangeSelection

Defined in

lexical/src/LexicalNode.ts:796

---

updateDOM

▸ updateDOM(_prevNode, _dom, _config): boolean

Parameters

Name	Type
_prevNode	unknown
_dom	HTMLElement
_config	EditorConfig

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:614

---

clone

▸ Static clone(_data): LexicalNode

Parameters

Name	Type
_data	unknown

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:185

---

getType

▸ Static getType(): string

Returns

string

Defined in

lexical/src/LexicalNode.ts:177