Skip to main content

Class: OverflowNode

@lexical/overflow.OverflowNode

Hierarchy

Constructors

constructor

new OverflowNode(key?)

Parameters

NameType
key?string

Overrides

ElementNode.constructor

Defined in

lexical-overflow/src/index.ts:40

Methods

createDOM

createDOM(config): HTMLElement

Parameters

NameType
configEditorConfig

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

lexical-overflow/src/index.ts:52


excludeFromCopy

excludeFromCopy(): boolean

Returns

boolean

Overrides

ElementNode.excludeFromCopy

Defined in

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

SerializedElementNode

Overrides

ElementNode.exportJSON

Defined in

lexical-overflow/src/index.ts:45


insertNewAfter

insertNewAfter(selection, restoreSelection?): null | LexicalNode

Parameters

NameTypeDefault value
selectionRangeSelectionundefined
restoreSelectionbooleantrue

Returns

null | LexicalNode

Overrides

ElementNode.insertNewAfter

Defined in

lexical-overflow/src/index.ts:65


updateDOM

updateDOM(prevNode, dom): boolean

Parameters

NameType
prevNodeOverflowNode
domHTMLElement

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

lexical-overflow/src/index.ts:61


clone

Static clone(node): OverflowNode

Parameters

NameType
nodeOverflowNode

Returns

OverflowNode

Overrides

ElementNode.clone

Defined in

lexical-overflow/src/index.ts:28


getType

Static getType(): string

Returns

string

Overrides

ElementNode.getType

Defined in

lexical-overflow/src/index.ts:24


importDOM

Static importDOM(): null

Returns

null

Overrides

ElementNode.importDOM

Defined in

lexical-overflow/src/index.ts:36


importJSON

Static importJSON(serializedNode): OverflowNode

Parameters

NameType
serializedNodeSerializedOverflowNode

Returns

OverflowNode

Overrides

ElementNode.importJSON

Defined in

lexical-overflow/src/index.ts:32