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:195
Methods
createDOM
▸ createDOM(_config, _editor): HTMLElement
Parameters
| Name | Type |
|---|---|
_config | EditorConfig |
_editor | LexicalEditor |
Returns
HTMLElement
Defined in
lexical/src/LexicalNode.ts:595
exportDOM
▸ exportDOM(editor): DOMExportOutput
Parameters
| Name | Type |
|---|---|
editor | LexicalEditor |
Returns
Defined in
lexical/src/LexicalNode.ts:617
exportJSON
▸ exportJSON(): SerializedLexicalNode
Returns
Defined in
lexical/src/LexicalNode.ts:622
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:265
getKey
▸ getKey(): string
Returns
string
Defined in
lexical/src/LexicalNode.ts:260
getLatest
▸ getLatest(): LexicalNode
Returns
Defined in
lexical/src/LexicalNode.ts:531
getNextSibling
▸ getNextSibling<T>(): null | T
Type parameters
| Name | Type |
|---|---|
T | extends LexicalNode<T> |
Returns
null | T
Defined in
lexical/src/LexicalNode.ts:359
getNextSiblings
▸ getNextSiblings<T>(): T[]
Type parameters
| Name | Type |
|---|---|
T | extends LexicalNode<T> |
Returns
T[]
Defined in
lexical/src/LexicalNode.ts:373
getNodesBetween
▸ getNodesBetween(targetNode): LexicalNode[]
Parameters
| Name | Type |
|---|---|
targetNode | LexicalNode |
Returns
Defined in
lexical/src/LexicalNode.ts:464
getParent
▸ getParent<T>(): null | T
Type parameters
| Name | Type |
|---|---|
T | extends ElementNode<T> |
Returns
null | T
Defined in
lexical/src/LexicalNode.ts:274
getParentKeys
▸ getParentKeys(): string[]
Returns
string[]
Defined in
lexical/src/LexicalNode.ts:324
getParentOrThrow
▸ getParentOrThrow<T>(): T
Type parameters
| Name | Type |
|---|---|
T | extends ElementNode<T> |
Returns
T
Defined in
lexical/src/LexicalNode.ts:282
getParents
▸ getParents(): ElementNode[]
Returns
Defined in
lexical/src/LexicalNode.ts:314
getPreviousSibling
▸ getPreviousSibling<T>(): null | T
Type parameters
| Name | Type |
|---|---|
T | extends LexicalNode<T> |
Returns
null | T
Defined in
lexical/src/LexicalNode.ts:334
getPreviousSiblings
▸ getPreviousSiblings<T>(): T[]
Type parameters
| Name | Type |
|---|---|
T | extends LexicalNode<T> |
Returns
T[]
Defined in
lexical/src/LexicalNode.ts:347
getTextContent
▸ getTextContent(): string
Returns
string
Defined in
lexical/src/LexicalNode.ts:585
getTextContentSize
▸ getTextContentSize(): number
Returns
number
Defined in
lexical/src/LexicalNode.ts:589
getTopLevelElement
▸ getTopLevelElement(): null | LexicalNode | ElementNode
Returns
null | LexicalNode | ElementNode
Defined in
lexical/src/LexicalNode.ts:290
getTopLevelElementOrThrow
▸ getTopLevelElementOrThrow(): LexicalNode | ElementNode
Returns
Defined in
lexical/src/LexicalNode.ts:302
getType
▸ getType(): string
Returns
string
Defined in
lexical/src/LexicalNode.ts:214
getWritable
▸ getWritable(): LexicalNode
Returns
Defined in
lexical/src/LexicalNode.ts:542
insertAfter
▸ insertAfter(nodeToInsert): LexicalNode
Parameters
| Name | Type |
|---|---|
nodeToInsert | LexicalNode |
Returns
Defined in
lexical/src/LexicalNode.ts:674
insertBefore
▸ insertBefore(nodeToInsert): LexicalNode
Parameters
| Name | Type |
|---|---|
nodeToInsert | LexicalNode |
Returns
Defined in
lexical/src/LexicalNode.ts:726
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:525
isParentOf
▸ isParentOf(targetNode): boolean
Parameters
| Name | Type |
|---|---|
targetNode | LexicalNode |
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:449
isSelected
▸ isSelected(): boolean
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:235
markDirty
▸ markDirty(): void
Returns
void
Defined in
lexical/src/LexicalNode.ts:783
remove
▸ remove(preserveEmptyParent?): void
Parameters
| Name | Type |
|---|---|
preserveEmptyParent? | boolean |
Returns
void
Defined in
lexical/src/LexicalNode.ts:636
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:640
selectNext
▸ selectNext(anchorOffset?, focusOffset?): RangeSelection
Parameters
| Name | Type |
|---|---|
anchorOffset? | number |
focusOffset? | number |
Returns
Defined in
lexical/src/LexicalNode.ts:767
selectPrevious
▸ selectPrevious(anchorOffset?, focusOffset?): RangeSelection
Parameters
| Name | Type |
|---|---|
anchorOffset? | number |
focusOffset? | number |
Returns
Defined in
lexical/src/LexicalNode.ts:751
updateDOM
▸ updateDOM(_prevNode, _dom, _config): boolean
Parameters
| Name | Type |
|---|---|
_prevNode | unknown |
_dom | HTMLElement |
_config | EditorConfig |
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:609
clone
▸ Static clone(_data): LexicalNode
Parameters
| Name | Type |
|---|---|
_data | unknown |
Returns
Defined in
lexical/src/LexicalNode.ts:187
getType
▸ Static getType(): string
Returns
string
Defined in
lexical/src/LexicalNode.ts:179
importJSON
▸ Static importJSON(_serializedNode): LexicalNode
Parameters
| Name | Type |
|---|---|
_serializedNode | SerializedLexicalNode |
Returns
Defined in
lexical/src/LexicalNode.ts:626