Class: HeadingNode
@lexical/rich-text.HeadingNode
Hierarchy
-
↳
HeadingNode
Constructors
constructor
• new HeadingNode(tag, key?): HeadingNode
Parameters
| Name | Type |
|---|---|
tag | HeadingTagType |
key? | string |
Returns
Overrides
Defined in
packages/lexical-rich-text/src/index.ts:237
Methods
collapseAtStart
▸ collapseAtStart(): true
Returns
true
Overrides
Defined in
packages/lexical-rich-text/src/index.ts:384
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-rich-text/src/index.ts:248
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
| Name | Type |
|---|---|
editor | LexicalEditor |
Returns
Overrides
Defined in
packages/lexical-rich-text/src/index.ts:318
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
Overrides
Defined in
packages/lexical-rich-text/src/index.ts:348
extractWithChild
▸ extractWithChild(): boolean
Returns
boolean
Overrides
Defined in
packages/lexical-rich-text/src/index.ts:394
getTag
▸ getTag(): HeadingTagType
Returns
Defined in
packages/lexical-rich-text/src/index.ts:242
insertNewAfter
▸ insertNewAfter(selection?, restoreSelection?): ParagraphNode | HeadingNode
Parameters
| Name | Type | Default value |
|---|---|---|
selection? | RangeSelection | undefined |
restoreSelection | boolean | true |
Returns
Overrides
Defined in
packages/lexical-rich-text/src/index.ts:358
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-rich-text/src/index.ts:260
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
| Name | Type |
|---|---|
node | HeadingNode |
Returns
Overrides
Defined in
packages/lexical-rich-text/src/index.ts:233
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-rich-text/src/index.ts:229
importDOM
▸ importDOM(): null | DOMConversionMap
Returns
null | DOMConversionMap
Overrides
ElementNode.importDOM
Defined in
packages/lexical-rich-text/src/index.ts:264
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
| Name | Type |
|---|---|
serializedNode | SerializedHeadingNode |