@lexical/rich-text
Classes
HeadingNode
Defined in: packages/lexical-rich-text/src/index.ts:218
Extends
Constructors
Constructor
new HeadingNode(
tag
,key?
):HeadingNode
Defined in: packages/lexical-rich-text/src/index.ts:230
Parameters
tag
key?
string
Returns
Overrides
Methods
collapseAtStart()
collapseAtStart():
true
Defined in: packages/lexical-rich-text/src/index.ts:387
Returns
true
Overrides
createDOM()
createDOM(
config
):HTMLElement
Defined in: packages/lexical-rich-text/src/index.ts:247
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 lifecycle.
Parameters
config
Returns
HTMLElement
Overrides
exportDOM()
exportDOM(
editor
):DOMExportOutput
Defined in: packages/lexical-rich-text/src/index.ts:317
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
editor
Returns
Overrides
exportJSON()
exportJSON():
SerializedHeadingNode
Defined in: packages/lexical-rich-text/src/index.ts:353
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
extractWithChild()
extractWithChild():
boolean
Defined in: packages/lexical-rich-text/src/index.ts:397
Returns
boolean
Overrides
getTag()
getTag():
HeadingTagType
Defined in: packages/lexical-rich-text/src/index.ts:235
Returns
insertNewAfter()
insertNewAfter(
selection?
,restoreSelection?
):ParagraphNode
|HeadingNode
Defined in: packages/lexical-rich-text/src/index.ts:361
Parameters
selection?
restoreSelection?
boolean
= true
Returns
Overrides
setTag()
setTag(
tag
):this
Defined in: packages/lexical-rich-text/src/index.ts:239
Parameters
tag
Returns
this
updateDOM()
updateDOM(
prevNode
,dom
,config
):boolean
Defined in: packages/lexical-rich-text/src/index.ts:259
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
prevNode
this
dom
HTMLElement
config
Returns
boolean
Overrides
updateFromJSON()
updateFromJSON(
serializedNode
):this
Defined in: packages/lexical-rich-text/src/index.ts:347
Update this LexicalNode instance from serialized JSON. It's recommended to implement as much logic as possible in this method instead of the static importJSON method, so that the functionality can be inherited in subclasses.
The LexicalUpdateJSON utility type should be used to ignore any type, version, or children properties in the JSON so that the extended JSON from subclasses are acceptable parameters for the super call.
If overridden, this method must call super.
Parameters
serializedNode
LexicalUpdateJSON
<SerializedHeadingNode
>
Returns
this
Example
class MyTextNode extends TextNode {
// ...
static importJSON(serializedNode: SerializedMyTextNode): MyTextNode {
return $createMyTextNode()
.updateFromJSON(serializedNode);
}
updateFromJSON(
serializedNode: LexicalUpdateJSON<SerializedMyTextNode>,
): this {
return super.updateFromJSON(serializedNode)
.setMyProperty(serializedNode.myProperty);
}
}
Overrides
clone()
static
clone(node
):HeadingNode
Defined in: packages/lexical-rich-text/src/index.ts:226
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
node
Returns
Overrides
getType()
static
getType():string
Defined in: packages/lexical-rich-text/src/index.ts:222
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
importDOM()
static
importDOM():null
|DOMConversionMap
Defined in: packages/lexical-rich-text/src/index.ts:263
Returns
null
| DOMConversionMap
Overrides
ElementNode.importDOM
importJSON()
static
importJSON(serializedNode
):HeadingNode
Defined in: packages/lexical-rich-text/src/index.ts:341
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
serializedNode
Returns
Overrides
QuoteNode
Defined in: packages/lexical-rich-text/src/index.ts:125
Extends
Methods
canMergeWhenEmpty()
canMergeWhenEmpty():
true
Defined in: packages/lexical-rich-text/src/index.ts:200
Determines whether this node, when empty, can merge with a first block of nodes being inserted.
This method is specifically called in RangeSelection.insertNodes to determine merging behavior during nodes insertion.
Returns
true
Example
// In a ListItemNode or QuoteNode implementation:
canMergeWhenEmpty(): true {
return true;
}
Overrides
collapseAtStart()
collapseAtStart():
true
Defined in: packages/lexical-rich-text/src/index.ts:192
Returns
true
Overrides
createDOM()
createDOM(
config
):HTMLElement
Defined in: packages/lexical-rich-text/src/index.ts:136
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 lifecycle.
Parameters
config
Returns
HTMLElement
Overrides
exportDOM()
exportDOM(
editor
):DOMExportOutput
Defined in: packages/lexical-rich-text/src/index.ts:154
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
editor
Returns
Overrides
insertNewAfter()
insertNewAfter(
_
,restoreSelection?
):ParagraphNode
Defined in: packages/lexical-rich-text/src/index.ts:184
Parameters
_
restoreSelection?
boolean
Returns
Overrides
updateDOM()
updateDOM(
prevNode
,dom
):boolean
Defined in: packages/lexical-rich-text/src/index.ts:141
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
prevNode
this
dom
HTMLElement
Returns
boolean
Overrides
clone()
static
clone(node
):QuoteNode
Defined in: packages/lexical-rich-text/src/index.ts:130
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
node
Returns
Overrides
getType()
static
getType():string
Defined in: packages/lexical-rich-text/src/index.ts:126
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
importDOM()
static
importDOM():null
|DOMConversionMap
Defined in: packages/lexical-rich-text/src/index.ts:145
Returns
null
| DOMConversionMap
Overrides
ElementNode.importDOM
importJSON()
static
importJSON(serializedNode
):QuoteNode
Defined in: packages/lexical-rich-text/src/index.ts:178
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
serializedNode
Returns
Overrides
Type Aliases
HeadingTagType
HeadingTagType =
"h1"
|"h2"
|"h3"
|"h4"
|"h5"
|"h6"
Defined in: packages/lexical-rich-text/src/index.ts:215
SerializedHeadingNode
SerializedHeadingNode =
Spread
<{tag
:"h1"
|"h2"
|"h3"
|"h4"
|"h5"
|"h6"
; },SerializedElementNode
>
Defined in: packages/lexical-rich-text/src/index.ts:111
SerializedQuoteNode
SerializedQuoteNode =
SerializedElementNode
Defined in: packages/lexical-rich-text/src/index.ts:122
Variables
DRAG_DROP_PASTE
const
DRAG_DROP_PASTE:LexicalCommand
<File
[]>
Defined in: packages/lexical-rich-text/src/index.ts:118
Functions
$createHeadingNode()
$createHeadingNode(
headingTag
):HeadingNode
Defined in: packages/lexical-rich-text/src/index.ts:438
Parameters
headingTag
HeadingTagType
= 'h1'
Returns
$createQuoteNode()
$createQuoteNode():
QuoteNode
Defined in: packages/lexical-rich-text/src/index.ts:205
Returns
$isHeadingNode()
$isHeadingNode(
node
):node is HeadingNode
Defined in: packages/lexical-rich-text/src/index.ts:444
Parameters
node
undefined
| null
| LexicalNode
Returns
node is HeadingNode
$isQuoteNode()
$isQuoteNode(
node
):node is QuoteNode
Defined in: packages/lexical-rich-text/src/index.ts:209
Parameters
node
undefined
| null
| LexicalNode
Returns
node is QuoteNode
eventFiles()
eventFiles(
event
): [boolean
,File
[],boolean
]
Defined in: packages/lexical-rich-text/src/index.ts:494
Parameters
event
DragEvent
| PasteCommandType
Returns
[boolean
, File
[], boolean
]
registerRichText()
registerRichText(
editor
): () =>void
Defined in: packages/lexical-rich-text/src/index.ts:591
Parameters
editor
Returns
():
void
Returns
void