Skip to content

Commit

Permalink
[lexical-website] Feature: Document the withKlass option for node rep…
Browse files Browse the repository at this point in the history
…lacement (#6890)

Co-authored-by: Bob Ippolito <bob@redivi.com>
  • Loading branch information
Shopiley and etrepum authored Nov 30, 2024
1 parent 8e0e300 commit b4260a6
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion packages/lexical-website/docs/concepts/node-replacement.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@


# Node Overrides
# Node Overrides / Node Replacements

Some of the most commonly used Lexical Nodes are owned and maintained by the core library. For example, ParagraphNode, HeadingNode, QuoteNode, List(Item)Node etc - these are all provided by Lexical packages, which provides an easier out-of-the-box experience for some editor features, but makes it difficult to override their behavior. For instance, if you wanted to change the behavior of ListNode, you would typically extend the class and override the methods. However, how would you tell Lexical to use *your* ListNode subclass in the ListPlugin instead of using the core ListNode? That's where Node Overrides can help.

Expand All @@ -22,6 +22,10 @@ const editorConfig = {
]
}
```
In the snippet above,
- `replace`: Specifies the core node type to be replaced.
- `with`: Defines a transformation function to replace instances of the original node to the custom node.
- `withKlass`: This option ensures that behaviors associated with the original node type work seamlessly with the replacement. For instance, node transforms or mutation listeners targeting ParagraphNode will also apply to CustomParagraphNode when withKlass is specified. Without this option, the custom node might not fully integrate with the editor's built-in features, leading to unexpected behavior.

Once this is done, Lexical will replace all ParagraphNode instances with CustomParagraphNode instances. One important use case for this feature is overriding the serialization behavior of core nodes. Check out the full example below.

Expand Down

0 comments on commit b4260a6

Please sign in to comment.