fix: default to rendering the editor immediately, while staying backward compatible

[nperez0111]

Changes Overview

A third PR for performance of the useEditor hook 😅.

What I've done here is combine a few of the different approaches and added a bit of my own spin to it:

Prior art:

• Remove intermediate render cycle from useEditor #4579
• feat(react): add useEditorForImmediateRender hook #4858
• fix: initially set editor object only on non-ssr environments #4864
• https://github.com/ueberdosis/tiptap/pull/4453/files#diff-13acb5e551812e195c1140c10ba5ac298a0005996d07756cfd77c2d4194cb350
• Initialize editor before setting event handlers #4916

What I've done here is to take a spin on #4579 and base it on a useSyncExternalStore instead (for efficient re-rendering handled by react).
While adding the performance optimization made by #4453 (re-using existing editor instances, and just updating their options if they change).
It is backward-compatible to people who use SSR (printing a warning and telling them they should set the new flag explicitly for forward-compatible but only in dev mode).
It is forward-compatible, where if you don't specify the new flag, people will automatically have the editor on first render.
If the flag is specified, you get better TS types since it is now guaranteed that you get an editor instance.
If you include the select function, you can effectively choose when the component should re-render by returning something different than selected before (inspired by useSelector in react-redux)
If you include the equalityFn function, you can choose how to compare your select function's return value (again inspired by useSelector in react-redux)

Implementation Approach

I've introduced 3 new options to the useEditor hook (and subsequently the editor provider).

• immediatelyRender which is to control the new vs. the old behavior
• select which is to give the consumer fine-grained control over rendering by selecting the values they care about in re-rendering the editor
• equalityFn which defines how to compare the values that the consumer generates with the select function

When not specifying the immediateRender value, if it is detected to be in SSR mode (i.e. no window object) it will be assumed to be false to not break Next.js users (but printing a message that they should be explicit about this), otherwise it will be assumed to be true reducing flicker in existing applications.

Eventually, when we have confidence to do so (i.e. the next major version) we can throw an error instead and have Next.js users (and other ssr frameworks) have to explicitly opt out for their use case (or perhaps a new hook).

Testing Done

I tested in the demos using all possible options and in a next application here is a table for reference:

env	immediatelyRender	result	error message
vite	false	useEditor returns null on first render, an editor instance afterwards	none
vite	true	useEditor returns an editor instance consistently	none
vite	missing AKA undefined	useEditor returns an editor instance consistently, since not in SSR mode	none
next	false	useEditor returns null on first render (client & server), an editor instance afterwards (client only, since server renders only once)	none
next	true	Error next can't use DOM APIs on the server & will fail to rehydrate	An error is thrown stating this is an invalid configuration in dev mode
next	missing AKA undefined	Warning in the console. useEditor returns null on first render (client & server), an editor instance afterwards (client only, since server renders only once)	A warning is printed to the console stating that the use should explicitly set the flag in dev mode

Testing this sort of thing in react can be a little complicated (since you need to control when react re-renders) but if someone knows of a way to test this I'm happy to add tests for it.

Verification Steps

Run the demos and set different values for immediatelyRender and in a Next.js app.

Additional Notes

I'm unsure what version tiptap claims to be compatible with, and I know older versions do not have useSyncExternalStore but I also know that react-redux uses a shim to make it compatible with older versions.

Checklist

• I have renamed my PR according to the naming conventions. (e.g. feat: Implement new feature or chore(deps): Update dependencies)
• My changes do not break the library.
• I have added tests where applicable.
• I have followed the project guidelines.
• I have fixed any lint issues.

Related Issues

#5001

[netlify]

✅ Deploy Preview for tiptap-embed ready!

Name	Link
🔨 Latest commit	57d60ec
🔍 Latest deploy log	https://app.netlify.com/sites/tiptap-embed/deploys/665b4bcf0cce8c0008d22533
😎 Deploy Preview	https://deploy-preview-5161--tiptap-embed.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

---

To edit notification comments on pull requests, go to your Netlify site configuration.

[nperez0111]

This was the closest thing I could find to detecting that you are running Next.js (SSR or CSR)