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:182
Methods
createDOM
▸ createDOM(_config
, _editor
): HTMLElement
Parameters
Name | Type |
---|---|
_config | EditorConfig |
_editor | LexicalEditor |
Returns
HTMLElement
Defined in
lexical/src/LexicalNode.ts:581
exportDOM
▸ exportDOM(editor
): DOMExportOutput
Parameters
Name | Type |
---|---|
editor | LexicalEditor |
Returns
Defined in
lexical/src/LexicalNode.ts:603
exportJSON
▸ exportJSON(): SerializedLexicalNode
Returns
Defined in
lexical/src/LexicalNode.ts:608
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:367
getIndexWithinParent
▸ getIndexWithinParent(): number
Returns
number
Defined in
lexical/src/LexicalNode.ts:254
getKey
▸ getKey(): string
Returns
string
Defined in
lexical/src/LexicalNode.ts:249
getLatest
▸ getLatest(): LexicalNode
Returns
Defined in
lexical/src/LexicalNode.ts:513
getNextSibling
▸ getNextSibling<T
>(): null
| T
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Returns
null
| T
Defined in
lexical/src/LexicalNode.ts:351
getNextSiblings
▸ getNextSiblings<T
>(): T
[]
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Returns
T
[]
Defined in
lexical/src/LexicalNode.ts:357
getNodesBetween
▸ getNodesBetween(targetNode
): LexicalNode
[]
Parameters
Name | Type |
---|---|
targetNode | LexicalNode |
Returns
Defined in
lexical/src/LexicalNode.ts:446
getParent
▸ getParent<T
>(): null
| T
Type parameters
Name | Type |
---|---|
T | extends ElementNode <T > |
Returns
null
| T
Defined in
lexical/src/LexicalNode.ts:271
getParentKeys
▸ getParentKeys(): string
[]
Returns
string
[]
Defined in
lexical/src/LexicalNode.ts:321
getParentOrThrow
▸ getParentOrThrow<T
>(): T
Type parameters
Name | Type |
---|---|
T | extends ElementNode <T > |
Returns
T
Defined in
lexical/src/LexicalNode.ts:279
getParents
▸ getParents(): ElementNode
[]
Returns
Defined in
lexical/src/LexicalNode.ts:311
getPreviousSibling
▸ getPreviousSibling<T
>(): null
| T
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Returns
null
| T
Defined in
lexical/src/LexicalNode.ts:331
getPreviousSiblings
▸ getPreviousSiblings<T
>(): T
[]
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Returns
T
[]
Defined in
lexical/src/LexicalNode.ts:337
getTextContent
▸ getTextContent(): string
Returns
string
Defined in
lexical/src/LexicalNode.ts:571
getTextContentSize
▸ getTextContentSize(): number
Returns
number
Defined in
lexical/src/LexicalNode.ts:575
getTopLevelElement
▸ getTopLevelElement(): null
| LexicalNode
| ElementNode
Returns
null
| LexicalNode
| ElementNode
Defined in
lexical/src/LexicalNode.ts:287
getTopLevelElementOrThrow
▸ getTopLevelElementOrThrow(): LexicalNode
| ElementNode
Returns
Defined in
lexical/src/LexicalNode.ts:299
getType
▸ getType(): string
Returns
string
Defined in
lexical/src/LexicalNode.ts:203
getWritable
▸ getWritable(): LexicalNode
Returns
Defined in
lexical/src/LexicalNode.ts:524
insertAfter
▸ insertAfter(nodeToInsert
, restoreSelection?
): LexicalNode
Parameters
Name | Type | Default value |
---|---|---|
nodeToInsert | LexicalNode | undefined |
restoreSelection | boolean | true |
Returns
Defined in
lexical/src/LexicalNode.ts:676
insertBefore
▸ insertBefore(nodeToInsert
, restoreSelection?
): LexicalNode
Parameters
Name | Type | Default value |
---|---|---|
nodeToInsert | LexicalNode | undefined |
restoreSelection | boolean | true |
Returns
Defined in
lexical/src/LexicalNode.ts:736
is
▸ is(object
): boolean
Parameters
Name | Type |
---|---|
object | undefined | null | LexicalNode |
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:393
isAttached
▸ isAttached(): boolean
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:207
isBefore
▸ isBefore(targetNode
): boolean
Parameters
Name | Type |
---|---|
targetNode | LexicalNode |
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:400
isDirty
▸ isDirty(): boolean
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:507
isParentOf
▸ isParentOf(targetNode
): boolean
Parameters
Name | Type |
---|---|
targetNode | LexicalNode |
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:431
isSelected
▸ isSelected(): boolean
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:224
markDirty
▸ markDirty(): void
Returns
void
Defined in
lexical/src/LexicalNode.ts:802
remove
▸ remove(preserveEmptyParent?
): void
Parameters
Name | Type |
---|---|
preserveEmptyParent? | boolean |
Returns
void
Defined in
lexical/src/LexicalNode.ts:622
replace
▸ replace<N
>(replaceWith
, restoreSelection?
): N
Type parameters
Name | Type |
---|---|
N | extends LexicalNode <N > |
Parameters
Name | Type | Default value |
---|---|---|
replaceWith | N | undefined |
restoreSelection | boolean | true |
Returns
N
Defined in
lexical/src/LexicalNode.ts:626
selectNext
▸ selectNext(anchorOffset?
, focusOffset?
): RangeSelection
Parameters
Name | Type |
---|---|
anchorOffset? | number |
focusOffset? | number |
Returns
Defined in
lexical/src/LexicalNode.ts:786
selectPrevious
▸ selectPrevious(anchorOffset?
, focusOffset?
): RangeSelection
Parameters
Name | Type |
---|---|
anchorOffset? | number |
focusOffset? | number |
Returns
Defined in
lexical/src/LexicalNode.ts:770
updateDOM
▸ updateDOM(_prevNode
, _dom
, _config
): boolean
Parameters
Name | Type |
---|---|
_prevNode | unknown |
_dom | HTMLElement |
_config | EditorConfig |
Returns
boolean
Defined in
lexical/src/LexicalNode.ts:595
clone
▸ Static
clone(_data
): LexicalNode
Parameters
Name | Type |
---|---|
_data | unknown |
Returns
Defined in
lexical/src/LexicalNode.ts:174
getType
▸ Static
getType(): string
Returns
string
Defined in
lexical/src/LexicalNode.ts:166
importJSON
▸ Static
importJSON(_serializedNode
): LexicalNode
Parameters
Name | Type |
---|---|
_serializedNode | SerializedLexicalNode |
Returns
Defined in
lexical/src/LexicalNode.ts:612