Skip to main content

Class: HeadingNode

@lexical/rich-text.HeadingNode

Hierarchy

Constructors

constructor

new HeadingNode(tag, key?): HeadingNode

Parameters

NameType
tagHeadingTagType
key?string

Returns

HeadingNode

Overrides

ElementNode.constructor

Defined in

packages/lexical-rich-text/src/index.ts:236

Methods

collapseAtStart

collapseAtStart(): true

Returns

true

Overrides

ElementNode.collapseAtStart

Defined in

packages/lexical-rich-text/src/index.ts:383


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

NameTypeDescription
configEditorConfigallows access to things like the EditorTheme (to apply classes) during reconciliation.

Returns

HTMLElement

Overrides

ElementNode.createDOM

Defined in

packages/lexical-rich-text/src/index.ts:247


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 $generateHtmlFromNodes. You could also use this method to build your own HTML renderer.

Parameters

NameType
editorLexicalEditor

Returns

DOMExportOutput

Overrides

ElementNode.exportDOM

Defined in

packages/lexical-rich-text/src/index.ts:317


exportJSON

exportJSON(): SerializedHeadingNode

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

SerializedHeadingNode

Overrides

ElementNode.exportJSON

Defined in

packages/lexical-rich-text/src/index.ts:347


extractWithChild

extractWithChild(): boolean

Returns

boolean

Overrides

ElementNode.extractWithChild

Defined in

packages/lexical-rich-text/src/index.ts:393


getTag

getTag(): HeadingTagType

Returns

HeadingTagType

Defined in

packages/lexical-rich-text/src/index.ts:241


insertNewAfter

insertNewAfter(selection?, restoreSelection?): ParagraphNode | HeadingNode

Parameters

NameTypeDefault value
selection?RangeSelectionundefined
restoreSelectionbooleantrue

Returns

ParagraphNode | HeadingNode

Overrides

ElementNode.insertNewAfter

Defined in

packages/lexical-rich-text/src/index.ts:357


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

NameType
prevNodeHeadingNode
domHTMLElement

Returns

boolean

Overrides

ElementNode.updateDOM

Defined in

packages/lexical-rich-text/src/index.ts:259


clone

clone(node): HeadingNode

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
nodeHeadingNode

Returns

HeadingNode

Overrides

ElementNode.clone

Defined in

packages/lexical-rich-text/src/index.ts:232


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

ElementNode.getType

Defined in

packages/lexical-rich-text/src/index.ts:228


importDOM

importDOM(): null | DOMConversionMap

Returns

null | DOMConversionMap

Overrides

ElementNode.importDOM

Defined in

packages/lexical-rich-text/src/index.ts:263


importJSON

importJSON(serializedNode): HeadingNode

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
serializedNodeSerializedHeadingNode

Returns

HeadingNode

Overrides

ElementNode.importJSON

Defined in

packages/lexical-rich-text/src/index.ts:339