Class: OverflowNode
@lexical/overflow.OverflowNode
Hierarchy
-
↳
OverflowNode
Methods
createDOM
▸ createDOM(config): HTMLElement
Called during the reconciliation process to determine which nodes to insert into the DOM for this Lexical Node.
This method must return exactly one HTMLElement. Nested elements are not supported.
Do not attempt to update the Lexical EditorState during this phase of the update lifecyle.
Parameters
| Name | Type | Description |
|---|---|---|
config | EditorConfig | allows access to things like the EditorTheme (to apply classes) during reconciliation. |
Returns
HTMLElement
Overrides
Defined in
packages/lexical-overflow/src/index.ts:37
excludeFromCopy
▸ excludeFromCopy(): boolean
Returns
boolean
Overrides
Defined in
packages/lexical-overflow/src/index.ts:58
insertNewAfter
▸ insertNewAfter(selection, restoreSelection?): null | LexicalNode
Parameters
| Name | Type | Default value |
|---|---|---|
selection | RangeSelection | undefined |
restoreSelection | boolean | true |
Returns
null | LexicalNode
Overrides
Defined in
packages/lexical-overflow/src/index.ts:50
updateDOM
▸ updateDOM(prevNode, dom): boolean
Called when a node changes and should update the DOM in whatever way is necessary to make it align with any changes that might have happened during the update.
Returning "true" here will cause lexical to unmount and recreate the DOM node (by calling createDOM). You would need to do this if the element tag changes, for instance.
Parameters
| Name | Type |
|---|---|
prevNode | this |
dom | HTMLElement |
Returns
boolean