Feature: Document the withKlass option for node replacement

[etrepum]

Description

When using node replacement, it's often useful to specify the withKlass option so that any behaviors that were intended for the original node type should work with the replaced node type (e.g. node transforms, mutation listeners, etc.).

• Concept documentation completed in [lexical-website] Feature: Document the withKlass option for node replacement #6890
• API documentation is still missing

Impact

Anyone replacing built-in nodes with extended versions should probably be using this, but they wouldn't know that it's even an option unless they were looking at the types or the source code. Even then, it would be tricky to know what the semantics are unless you have a pretty thorough understanding of how the editor is constructed and how listeners work.

It may even be worth a lint and/or a warning when this is not specified.

[Shopiley]

Hi, I can take this up. But just to clarify, we want to add an explanation of the withKlass option in the docs and also implement a lint for it?

[etrepum]

How about you just work on the documentation, adding a lint is probably a bit tricky

[etrepum]

Re-opened until we have API documentation

[Shopiley]

I also noticed that the code example in the sandbox does not use the withKlass option. Not sure if I can change this as it was created by someone else but it should be changed.

[etrepum]

That example should be replaced with a stackblitz example that comes from this repository like the others

[Shopiley]

Okay, do I just add the example to the repo and host it on my stackblitz account?

[etrepum]

If the example is in the repo then you can create a stackblitz URL directly to it. Take a look at any of the existing stackblitz URLs in the docs