Class: ElementNode
lexical.ElementNode
Hierarchy
↳
ElementNode
↳↳
LinkNode
↳↳
OverflowNode
↳↳
RootNode
↳↳
CodeNode
↳↳
ListItemNode
↳↳
ListNode
↳↳
MarkNode
Constructors
constructor
• new ElementNode(key?
)
Parameters
Name | Type |
---|---|
key? | string |
Overrides
Defined in
lexical/src/nodes/LexicalElementNode.ts:63
Methods
append
▸ append(...nodesToAppend
): ElementNode
Parameters
Name | Type |
---|---|
...nodesToAppend | LexicalNode [] |
Returns
Defined in
lexical/src/nodes/LexicalElementNode.ts:300
canBeEmpty
▸ canBeEmpty(): boolean
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:471
canExtractContents
▸ canExtractContents(): boolean
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:462
canIndent
▸ canIndent(): boolean
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:453
canInsertAfter
▸ canInsertAfter(node
): boolean
Parameters
Name | Type |
---|---|
node | LexicalNode |
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:468
canInsertTab
▸ canInsertTab(): boolean
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:450
canInsertTextAfter
▸ canInsertTextAfter(): boolean
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:477
canInsertTextBefore
▸ canInsertTextBefore(): boolean
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:474
canMergeWith
▸ canMergeWith(node
): boolean
Parameters
Name | Type |
---|---|
node | ElementNode |
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:486
canReplaceWith
▸ canReplaceWith(replacement
): boolean
Parameters
Name | Type |
---|---|
replacement | LexicalNode |
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:465
clear
▸ clear(): ElementNode
Returns
Defined in
lexical/src/nodes/LexicalElementNode.ts:294
collapseAtStart
▸ collapseAtStart(selection
): boolean
Parameters
Name | Type |
---|---|
selection | RangeSelection |
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:456
excludeFromCopy
▸ excludeFromCopy(destination?
): boolean
Parameters
Name | Type |
---|---|
destination? | "html" | "clone" |
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:459
exportJSON
▸ exportJSON(): SerializedElementNode
Returns
Overrides
Defined in
lexical/src/nodes/LexicalElementNode.ts:436
extractWithChild
▸ extractWithChild(child
, selection
, destination
): boolean
Parameters
Name | Type |
---|---|
child | LexicalNode |
selection | null | RangeSelection | NodeSelection | GridSelection |
destination | "html" | "clone" |
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:489
getAllTextNodes
▸ getAllTextNodes(includeInert?
): TextNode
[]
Parameters
Name | Type |
---|---|
includeInert? | boolean |
Returns
TextNode
[]
Defined in
lexical/src/nodes/LexicalElementNode.ts:115
getChildAtIndex
▸ getChildAtIndex<T
>(index
): null
| T
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Parameters
Name | Type |
---|---|
index | number |
Returns
null
| T
Defined in
lexical/src/nodes/LexicalElementNode.ts:203
getChildren
▸ getChildren<T
>(): T
[]
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Returns
T
[]
Defined in
lexical/src/nodes/LexicalElementNode.ts:83
getChildrenKeys
▸ getChildrenKeys(): string
[]
Returns
string
[]
Defined in
lexical/src/nodes/LexicalElementNode.ts:95
getChildrenSize
▸ getChildrenSize(): number
Returns
number
Defined in
lexical/src/nodes/LexicalElementNode.ts:98
getDescendantByIndex
▸ getDescendantByIndex<T
>(index
): null
| T
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Parameters
Name | Type |
---|---|
index | number |
Returns
null
| T
Defined in
lexical/src/nodes/LexicalElementNode.ts:158
getDirection
▸ getDirection(): null
| "ltr"
| "rtl"
Returns
null
| "ltr"
| "rtl"
Defined in
lexical/src/nodes/LexicalElementNode.ts:229
getFirstChild
▸ getFirstChild<T
>(): null
| T
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Returns
null
| T
Defined in
lexical/src/nodes/LexicalElementNode.ts:178
getFirstChildOrThrow
▸ getFirstChildOrThrow<T
>(): T
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Returns
T
Defined in
lexical/src/nodes/LexicalElementNode.ts:187
getFirstDescendant
▸ getFirstDescendant<T
>(): null
| T
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Returns
null
| T
Defined in
lexical/src/nodes/LexicalElementNode.ts:130
getFormat
▸ getFormat(): number
Returns
number
Defined in
lexical/src/nodes/LexicalElementNode.ts:71
getFormatType
▸ getFormatType(): ElementFormatType
Returns
Defined in
lexical/src/nodes/LexicalElementNode.ts:75
getIndent
▸ getIndent(): number
Returns
number
Defined in
lexical/src/nodes/LexicalElementNode.ts:79
getLastChild
▸ getLastChild<T
>(): null
| T
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Returns
null
| T
Defined in
lexical/src/nodes/LexicalElementNode.ts:194
getLastDescendant
▸ getLastDescendant<T
>(): null
| T
Type parameters
Name | Type |
---|---|
T | extends LexicalNode <T > |
Returns
null
| T
Defined in
lexical/src/nodes/LexicalElementNode.ts:144
getTextContent
▸ getTextContent(includeInert?
, includeDirectionless?
): string
Parameters
Name | Type |
---|---|
includeInert? | boolean |
includeDirectionless? | false |
Returns
string
Overrides
Defined in
lexical/src/nodes/LexicalElementNode.ts:212
hasFormat
▸ hasFormat(type
): boolean
Parameters
Name | Type |
---|---|
type | ElementFormatType |
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:233
insertNewAfter
▸ insertNewAfter(selection
): null
| LexicalNode
Parameters
Name | Type |
---|---|
selection | RangeSelection |
Returns
null
| LexicalNode
Defined in
lexical/src/nodes/LexicalElementNode.ts:447
isDirty
▸ isDirty(): boolean
Returns
boolean
Overrides
Defined in
lexical/src/nodes/LexicalElementNode.ts:105
isEmpty
▸ isEmpty(): boolean
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:102
isInline
▸ isInline(): boolean
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:480
isLastChild
▸ isLastChild(): boolean
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:110
isTopLevel
▸ isTopLevel(): boolean
Returns
boolean
Defined in
lexical/src/nodes/LexicalElementNode.ts:483
select
▸ select(_anchorOffset?
, _focusOffset?
): RangeSelection
Parameters
Name | Type |
---|---|
_anchorOffset? | number |
_focusOffset? | number |
Returns
Defined in
lexical/src/nodes/LexicalElementNode.ts:243
selectEnd
▸ selectEnd(): RangeSelection
Returns
Defined in
lexical/src/nodes/LexicalElementNode.ts:283
selectStart
▸ selectStart(): RangeSelection
Returns
Defined in
lexical/src/nodes/LexicalElementNode.ts:272
setDirection
▸ setDirection(direction
): ElementNode
Parameters
Name | Type |
---|---|
direction | null | "ltr" | "rtl" |
Returns
Defined in
lexical/src/nodes/LexicalElementNode.ts:303
setFormat
▸ setFormat(type
): ElementNode
Parameters
Name | Type |
---|---|
type | ElementFormatType |
Returns
Defined in
lexical/src/nodes/LexicalElementNode.ts:308
setIndent
▸ setIndent(indentLevel
): ElementNode
Parameters
Name | Type |
---|---|
indentLevel | number |
Returns
Defined in
lexical/src/nodes/LexicalElementNode.ts:313
splice
▸ splice(start
, deleteCount
, nodesToInsert
): ElementNode
Parameters
Name | Type |
---|---|
start | number |
deleteCount | number |
nodesToInsert | LexicalNode [] |
Returns
Defined in
lexical/src/nodes/LexicalElementNode.ts:318