@lexical/overflow
Classes
OverflowNode
Defined in: packages/lexical-overflow/src/index.ts:21
Extends
Methods
createDOM()
createDOM(
config
):HTMLElement
Defined in: packages/lexical-overflow/src/index.ts:34
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 lifecycle.
Parameters
config
Returns
HTMLElement
Overrides
excludeFromCopy()
excludeFromCopy():
boolean
Defined in: packages/lexical-overflow/src/index.ts:55
Returns
boolean
Overrides
insertNewAfter()
insertNewAfter(
selection
,restoreSelection
):null
|LexicalNode
Defined in: packages/lexical-overflow/src/index.ts:47
Parameters
selection
restoreSelection
boolean
= true
Returns
null
| LexicalNode
Overrides
updateDOM()
updateDOM(
prevNode
,dom
):boolean
Defined in: packages/lexical-overflow/src/index.ts:43
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
prevNode
this
dom
HTMLElement
Returns
boolean
Overrides
Type Aliases
SerializedOverflowNode
SerializedOverflowNode =
SerializedElementNode
Defined in: packages/lexical-overflow/src/index.ts:18
Functions
$createOverflowNode()
$createOverflowNode():
OverflowNode
Defined in: packages/lexical-overflow/src/index.ts:60
Returns
$isOverflowNode()
$isOverflowNode(
node
):node is OverflowNode
Defined in: packages/lexical-overflow/src/index.ts:64
Parameters
node
undefined
| null
| LexicalNode
Returns
node is OverflowNode