Class: OverflowNode
@lexical/overflow.OverflowNode
Hierarchy
-
↳
OverflowNode
Constructors
constructor
• new OverflowNode(key?): OverflowNode
Parameters
| Name | Type |
|---|---|
key? | string |
Returns
Overrides
Defined in
packages/lexical-overflow/src/index.ts:40
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:52
excludeFromCopy
▸ excludeFromCopy(): boolean
Returns
boolean
Overrides
Defined in
packages/lexical-overflow/src/index.ts:73
exportJSON
▸ exportJSON(): SerializedElementNode
Controls how the this node is serialized to JSON. This is important for copy and paste between Lexical editors sharing the same namespace. It's also important if you're serializing to JSON for persistent storage somewhere. See Serialization & Deserialization.
Returns
Overrides
Defined in
packages/lexical-overflow/src/index.ts:45
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:65
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
Overrides
Defined in
packages/lexical-overflow/src/index.ts:61
clone
▸ clone(node): OverflowNode
Clones this node, creating a new node with a different key and adding it to the EditorState (but not attaching it anywhere!). All nodes must implement this method.
Parameters
| Name | Type |
|---|---|
node | OverflowNode |
Returns
Overrides
Defined in
packages/lexical-overflow/src/index.ts:28
getType
▸ getType(): string
Returns the string type of this node. Every node must implement this and it MUST BE UNIQUE amongst nodes registered on the editor.
Returns
string
Overrides
Defined in
packages/lexical-overflow/src/index.ts:24
importDOM
▸ importDOM(): null
Returns
null
Overrides
ElementNode.importDOM
Defined in
packages/lexical-overflow/src/index.ts:36
importJSON
▸ importJSON(serializedNode): OverflowNode
Controls how the this node is deserialized from JSON. This is usually boilerplate, but provides an abstraction between the node implementation and serialized interface that can be important if you ever make breaking changes to a node schema (by adding or removing properties). See Serialization & Deserialization.
Parameters
| Name | Type |
|---|---|
serializedNode | SerializedOverflowNode |
Returns
Overrides
Defined in
packages/lexical-overflow/src/index.ts:32
transform
▸ transform(): (node: LexicalNode) => void
Registers the returned function as a transform on the node during Editor initialization. Most such use cases should be addressed via the LexicalEditor.registerNodeTransform API.
Experimental - use at your own risk.
Returns
fn
▸ (node): void
Parameters
| Name | Type |
|---|---|
node | LexicalNode |
Returns
void