Skip to main content

Class: LexicalNode

lexical.LexicalNode

Hierarchy

Constructors

constructor

new LexicalNode(key?): LexicalNode

Parameters

NameType
key?string

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:208

Properties

constructor

constructor: KlassConstructor<typeof LexicalNode>

Defined in

lexical/src/LexicalNode.ts:159


importDOM

Static Optional importDOM: () => null | DOMConversionMap<any>

Type declaration

▸ (): null | DOMConversionMap<any>

Returns

null | DOMConversionMap<any>

Defined in

lexical/src/LexicalNode.ts:206

Methods

createDOM

createDOM(_config, _editor): 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

NameTypeDescription
_configEditorConfigallows access to things like the EditorTheme (to apply classes) during reconciliation.
_editorLexicalEditorallows access to the editor for context during reconciliation.

Returns

HTMLElement

Defined in

lexical/src/LexicalNode.ts:759


createParentElementNode

createParentElementNode(): ElementNode

The creation logic for any required parent. Should be implemented if isParentRequired returns true.

Returns

ElementNode

Defined in

lexical/src/LexicalNode.ts:1038


exportDOM

exportDOM(editor): DOMExportOutput

Controls how the this node is serialized to HTML. This is important for copy and paste between Lexical and non-Lexical editors, or Lexical editors with different namespaces, in which case the primary transfer format is HTML. It's also important if you're serializing to HTML for any other reason via @lexical/html!$generateHtmlFromNodes. You could also use this method to build your own HTML renderer.

Parameters

NameType
editorLexicalEditor

Returns

DOMExportOutput

Defined in

lexical/src/LexicalNode.ts:789


exportJSON

exportJSON(): SerializedLexicalNode

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

SerializedLexicalNode

Defined in

lexical/src/LexicalNode.ts:801


getCommonAncestor

getCommonAncestor<T>(node): null | T

Returns the closest common ancestor of this node and the provided one or null if one cannot be found.

Type parameters

NameType
Textends ElementNode = ElementNode

Parameters

NameTypeDescription
nodeLexicalNodethe other node to find the common ancestor of.

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:478


getIndexWithinParent

getIndexWithinParent(): number

Returns the zero-based index of this node within the parent.

Returns

number

Defined in

lexical/src/LexicalNode.ts:306


getKey

getKey(): string

Returns this nodes key.

Returns

string

Defined in

lexical/src/LexicalNode.ts:298


getLatest

getLatest(): this

Returns the latest version of the node from the active EditorState. This is used to avoid getting values from stale node references.

Returns

this

Defined in

lexical/src/LexicalNode.ts:664


getNextSibling

getNextSibling<T>(): null | T

Returns the "next" siblings - that is, the node that comes after this one in the same parent

Type parameters

NameType
Textends LexicalNode

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:451


getNextSiblings

getNextSiblings<T>(): T[]

Returns all "next" siblings - that is, the nodes that come between this one and the last child of it's parent, inclusive.

Type parameters

NameType
Textends LexicalNode

Returns

T[]

Defined in

lexical/src/LexicalNode.ts:462


getNodesBetween

getNodesBetween(targetNode): LexicalNode[]

Returns a list of nodes that are between this node and the target node in the EditorState.

Parameters

NameTypeDescription
targetNodeLexicalNodethe node that marks the other end of the range of nodes to be returned.

Returns

LexicalNode[]

Defined in

lexical/src/LexicalNode.ts:583


getParent

getParent<T>(): null | T

Returns the parent of this node, or null if none is found.

Type parameters

NameType
Textends ElementNode

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:326


getParentKeys

getParentKeys(): string[]

Returns a list of the keys of every ancestor of this node, all the way up to the RootNode.

Returns

string[]

Defined in

lexical/src/LexicalNode.ts:403


getParentOrThrow

getParentOrThrow<T>(): T

Returns the parent of this node, or throws if none is found.

Type parameters

NameType
Textends ElementNode

Returns

T

Defined in

lexical/src/LexicalNode.ts:337


getParents

getParents(): ElementNode[]

Returns a list of the every ancestor of this node, all the way up to the RootNode.

Returns

ElementNode[]

Defined in

lexical/src/LexicalNode.ts:388


getPreviousSibling

getPreviousSibling<T>(): null | T

Returns the "previous" siblings - that is, the node that comes before this one in the same parent.

Type parameters

NameType
Textends LexicalNode

Returns

null | T

Defined in

lexical/src/LexicalNode.ts:418


getPreviousSiblings

getPreviousSiblings<T>(): T[]

Returns the "previous" siblings - that is, the nodes that come between this one and the first child of it's parent, inclusive.

Type parameters

NameType
Textends LexicalNode

Returns

T[]

Defined in

lexical/src/LexicalNode.ts:429


getTextContent

getTextContent(): string

Returns the text content of the node. Override this for custom nodes that should have a representation in plain text format (for copy + paste, for example)

Returns

string

Defined in

lexical/src/LexicalNode.ts:733


getTextContentSize

getTextContentSize(): number

Returns the length of the string produced by calling getTextContent on this node.

Returns

number

Defined in

lexical/src/LexicalNode.ts:741


getTopLevelElement

getTopLevelElement(): null | ElementNode

Returns the highest (in the EditorState tree) non-root ancestor of this node, or null if none is found. See lexical!$isRootOrShadowRoot for more information on which Elements comprise "roots".

Returns

null | ElementNode

Defined in

lexical/src/LexicalNode.ts:350


getTopLevelElementOrThrow

getTopLevelElementOrThrow(): ElementNode

Returns the highest (in the EditorState tree) non-root ancestor of this node, or throws if none is found. See lexical!$isRootOrShadowRoot for more information on which Elements comprise "roots".

Returns

ElementNode

Defined in

lexical/src/LexicalNode.ts:371


getType

getType(): string

Returns the string type of this node.

Returns

string

Defined in

lexical/src/LexicalNode.ts:227


getWritable

getWritable(): this

Returns a mutable version of the node. Will throw an error if called outside of a Lexical Editor LexicalEditor.update callback.

Returns

this

Defined in

lexical/src/LexicalNode.ts:680


insertAfter

insertAfter(nodeToInsert, restoreSelection?): LexicalNode

Inserts a node after this LexicalNode (as the next sibling).

Parameters

NameTypeDefault valueDescription
nodeToInsertLexicalNodeundefinedThe node to insert after this one.
restoreSelectionbooleantrueWhether or not to attempt to resolve the selection to the appropriate place after the operation is complete.

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:923


insertBefore

insertBefore(nodeToInsert, restoreSelection?): LexicalNode

Inserts a node before this LexicalNode (as the previous sibling).

Parameters

NameTypeDefault valueDescription
nodeToInsertLexicalNodeundefinedThe node to insert before this one.
restoreSelectionbooleantrueWhether or not to attempt to resolve the selection to the appropriate place after the operation is complete.

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:990


is

is(object): boolean

Returns true if the provided node is the exact same one as this node, from Lexical's perspective. Always use this instead of referential equality.

Parameters

NameTypeDescription
objectundefined | null | LexicalNodethe node to perform the equality comparison on.

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:510


isAttached

isAttached(): boolean

Returns true if there is a path between this node and the RootNode, false otherwise. This is a way of determining if the node is "attached" EditorState. Unattached nodes won't be reconciled and will ultimatelt be cleaned up by the Lexical GC.

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:244


isBefore

isBefore(targetNode): boolean

Returns true if this node logical precedes the target node in the editor state.

Parameters

NameTypeDescription
targetNodeLexicalNodethe node we're testing to see if it's after this one.

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:522


isDirty

isDirty(): boolean

Returns true if this node has been marked dirty during this update cycle.

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:653


isInline

isInline(): boolean

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:231


isParentOf

isParentOf(targetNode): boolean

Returns true if this node is the parent of the target node, false otherwise.

Parameters

NameTypeDescription
targetNodeLexicalNodethe would-be child node.

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:561


isParentRequired

isParentRequired(): boolean

Whether or not this node has a required parent. Used during copy + paste operations to normalize nodes that would otherwise be orphaned. For example, ListItemNodes without a ListNode parent or TextNodes with a ParagraphNode parent.

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:1030


isSelected

isSelected(selection?): boolean

Returns true if this node is contained within the provided Selection., false otherwise. Relies on the algorithms implemented in BaseSelection.getNodes to determine what's included.

Parameters

NameTypeDescription
selection?null | BaseSelectionThe selection that we want to determine if the node is in.

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:268


markDirty

markDirty(): void

Marks a node dirty, triggering transforms and forcing it to be reconciled during the update cycle.

Returns

void

Defined in

lexical/src/LexicalNode.ts:1099


remove

remove(preserveEmptyParent?): void

Removes this LexicalNode from the EditorState. If the node isn't re-inserted somewhere, the Lexical garbage collector will eventually clean it up.

Parameters

NameTypeDescription
preserveEmptyParent?booleanIf falsy, the node's parent will be removed if it's empty after the removal operation. This is the default behavior, subject to other node heuristics such as ElementNode#canBeEmpty

Returns

void

Defined in

lexical/src/LexicalNode.ts:842


replace

replace<N>(replaceWith, includeChildren?): N

Replaces this LexicalNode with the provided node, optionally transferring the children of the replaced node to the replacing node.

Type parameters

NameType
Nextends LexicalNode

Parameters

NameTypeDescription
replaceWithNThe node to replace this one with.
includeChildren?booleanWhether or not to transfer the children of this node to the replacing node.

Returns

N

Defined in

lexical/src/LexicalNode.ts:853


selectEnd

selectEnd(): RangeSelection

Returns

RangeSelection

Defined in

lexical/src/LexicalNode.ts:1046


selectNext

selectNext(anchorOffset?, focusOffset?): RangeSelection

Moves selection to the next sibling of this node, at the specified offsets.

Parameters

NameTypeDescription
anchorOffset?numberThe anchor offset for selection.
focusOffset?numberThe focus offset for selection

Returns

RangeSelection

Defined in

lexical/src/LexicalNode.ts:1078


selectPrevious

selectPrevious(anchorOffset?, focusOffset?): RangeSelection

Moves selection to the previous sibling of this node, at the specified offsets.

Parameters

NameTypeDescription
anchorOffset?numberThe anchor offset for selection.
focusOffset?numberThe focus offset for selection

Returns

RangeSelection

Defined in

lexical/src/LexicalNode.ts:1056


selectStart

selectStart(): RangeSelection

Returns

RangeSelection

Defined in

lexical/src/LexicalNode.ts:1042


updateDOM

updateDOM(_prevNode, _dom, _config): 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

NameType
_prevNodeunknown
_domHTMLElement
_configEditorConfig

Returns

boolean

Defined in

lexical/src/LexicalNode.ts:773


clone

clone(_data): LexicalNode

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

NameType
_dataunknown

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:197


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

Defined in

lexical/src/LexicalNode.ts:183


importJSON

importJSON(_serializedNode): LexicalNode

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

NameType
_serializedNodeSerializedLexicalNode

Returns

LexicalNode

Defined in

lexical/src/LexicalNode.ts:812


transform

transform(): null | (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

null | (node: LexicalNode) => void

Defined in

lexical/src/LexicalNode.ts:828