Class: LexicalNode
lexical.LexicalNode
Hierarchy
LexicalNode↳
TextNode
Indexable
▪ [x: string]: any
Constructors
constructor
• new LexicalNode(key?)
Parameters
| Name | Type |
|---|---|
key? | string |
Defined in
lexical/src/LexicalNode.ts:200
Methods
createDOM
▸ createDOM(_config, _editor): HTMLElement
Parameters
| Name | Type |
|---|---|
_config | EditorConfig |
_editor | LexicalEditor |
Returns
HTMLElement
Defined in
lexical/src/LexicalNode.ts:602
exportDOM
▸ exportDOM(editor): DOMExportOutput
Parameters
| Name | Type |
|---|---|
editor | LexicalEditor |
Returns
Defined in
lexical/src/LexicalNode.ts:624
exportJSON
▸ exportJSON(): SerializedLexicalNode
Returns
Defined in
lexical/src/LexicalNode.ts:629
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:392
getIndexWithinParent
▸ getIndexWithinParent(): number
Returns
number
Defined in
lexical/src/LexicalNode.ts:272
getKey
▸ getKey(): string
Returns
string
Defined in
lexical/src/LexicalNode.ts:267
getLatest
▸ getLatest(): LexicalNode
Returns
Defined in
lexical/src/LexicalNode.ts:538
getNextSibling
▸ getNextSibling<T>(): null | T
Type parameters
| Name | Type |
|---|---|
T | extends LexicalNode<T> |
Returns
null | T
Defined in
lexical/src/LexicalNode.ts:366
getNextSiblings
▸ getNextSiblings<T>(): T[]
Type parameters
| Name | Type |
|---|---|
T | extends LexicalNode<T> |
Returns
T[]
Defined in
lexical/src/LexicalNode.ts:380
getNodesBetween
▸ getNodesBetween(targetNode): LexicalNode[]
Parameters
| Name | Type |
|---|---|
targetNode | LexicalNode |
Returns
Defined in
lexical/src/LexicalNode.ts:471
getParent
▸ getParent<T>(): null | T
Type parameters
| Name | Type |
|---|---|
T | extends ElementNode<T> |
Returns
null | T
Defined in
lexical/src/LexicalNode.ts:281
getParentKeys
▸ getParentKeys(): string[]
Returns
string[]
Defined in
lexical/src/LexicalNode.ts:331
getParentOrThrow
▸ getParentOrThrow<T>(): T
Type parameters
| Name | Type |
|---|---|
T | extends ElementNode<T> |
Returns
T
Defined in
lexical/src/LexicalNode.ts:289
getParents
▸ getParents(): ElementNode[]
Returns
Defined in
lexical/src/LexicalNode.ts:321
getPreviousSibling
▸ getPreviousSibling<T>(): null | T
Type parameters
| Name | Type |
|---|---|
T | extends LexicalNode<T> |
Returns
null | T
Defined in
lexical/src/LexicalNode.ts:341
getPreviousSiblings
▸ getPreviousSiblings<T>(): T[]
Type parameters
| Name | Type |
|---|---|
T | extends LexicalNode<T> |
Returns
T[]
Defined in
lexical/src/LexicalNode.ts:354
getTextContent
▸ getTextContent(): string
Returns
string
Defined in
lexical/src/LexicalNode.ts:592
getTextContentSize
▸ getTextContentSize(): number
Returns
number
Defined in
lexical/src/LexicalNode.ts:596
getTopLevelElement
▸ getTopLevelElement(): null | LexicalNode | ElementNode
Returns
null | LexicalNode | ElementNode
Defined in
lexical/src/LexicalNode.ts:297
getTopLevelElementOrThrow
▸ getTopLevelElementOrThrow(): LexicalNode | ElementNode
Returns
Defined in
lexical/src/LexicalNode.ts:309
getType
▸ getType(): string
Returns
string
Defined in
lexical/src/LexicalNode.ts:221
getWritable
▸ getWritable(): LexicalNode
Returns
Defined in
lexical/src/LexicalNode.ts:549
insertAfter
▸ insertAfter(nodeToInsert): LexicalNode
Parameters
| Name | Type |
|---|---|
nodeToInsert | LexicalNode |
Returns
Defined in
lexical/src/LexicalNode.ts:682
insertBefore
▸ insertBefore(nodeToInsert): LexicalNode
Parameters
| Name | Type |
|---|---|
nodeToInsert | LexicalNode |
Returns
Defined in
lexical/src/LexicalNode.ts:735
is
▸ is(object): boolean
Parameters
| Name | Type |
|---|---|
object | undefined | null | LexicalNode |
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:418
isAttached
▸ isAttached(): boolean
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:225
isBefore
▸ isBefore(targetNode): boolean
Parameters
| Name | Type |
|---|---|
targetNode | LexicalNode |
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:425
isDirty
▸ isDirty(): boolean
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:532
isParentOf
▸ isParentOf(targetNode): boolean
Parameters
| Name | Type |
|---|---|
targetNode | LexicalNode |
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:456
isSelected
▸ isSelected(): boolean
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:242
markDirty
▸ markDirty(): void
Returns
void
Defined in
lexical/src/LexicalNode.ts:794
remove
▸ remove(preserveEmptyParent?): void
Parameters
| Name | Type |
|---|---|
preserveEmptyParent? | boolean |
Returns
void
Defined in
lexical/src/LexicalNode.ts:643
replace
▸ replace<N>(replaceWith): N
Type parameters
| Name | Type |
|---|---|
N | extends LexicalNode<N> |
Parameters
| Name | Type |
|---|---|
replaceWith | N |
Returns
N
Defined in
lexical/src/LexicalNode.ts:647
selectNext
▸ selectNext(anchorOffset?, focusOffset?): RangeSelection
Parameters
| Name | Type |
|---|---|
anchorOffset? | number |
focusOffset? | number |
Returns
Defined in
lexical/src/LexicalNode.ts:778
selectPrevious
▸ selectPrevious(anchorOffset?, focusOffset?): RangeSelection
Parameters
| Name | Type |
|---|---|
anchorOffset? | number |
focusOffset? | number |
Returns
Defined in
lexical/src/LexicalNode.ts:762
updateDOM
▸ updateDOM(_prevNode, _dom, _config): boolean
Parameters
| Name | Type |
|---|---|
_prevNode | unknown |
_dom | HTMLElement |
_config | EditorConfig |
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:616
clone
▸ Static clone(_data): LexicalNode
Parameters
| Name | Type |
|---|---|
_data | unknown |
Returns
Defined in
lexical/src/LexicalNode.ts:192
getType
▸ Static getType(): string
Returns
string
Defined in
lexical/src/LexicalNode.ts:184
importJSON
▸ Static importJSON(_serializedNode): LexicalNode
Parameters
| Name | Type |
|---|---|
_serializedNode | SerializedLexicalNode |
Returns
Defined in
lexical/src/LexicalNode.ts:633