fix: default to rendering the editor immediately, while staying backward compatible #5161
Conversation
✅ Deploy Preview for tiptap-embed ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| } from 'react' | ||
|
|
||
| import { Editor } from './Editor.js' | ||
|
|
||
| const isDev = process.env.NODE_ENV !== 'production' | ||
| const isSSR = typeof window === 'undefined' | ||
| const isNext = isSSR || Boolean(typeof window !== 'undefined' && (window as any).next) |
There was a problem hiding this comment.
This was the closest thing I could find to detecting that you are running Next.js (SSR or CSR)
nperez0111
force-pushed
the
fix/react-rerenders
branch
2 times, most recently
from
2ae6496
to
8b9819b
Compare
The use case of a selector would be two-fold. For preventing re-renders by allowing you to only re-render when that selected state changes (e.g. not on every transaction like it is by default), and to give a more convenient API for tiptap state. I haven't updated the PR yet, but I envision an additional API like: function MyComponent() {
const { editor, state } = useEditorWithState({
selector: (currentEditor) => {
return { isBold: !currentEditor.can().setBold() };
},
equalityFn: deepEqual
});
return (
<>
<Toolbar>
<button>{state.isBold ? "Bold" : "Not Bold"}</button>
</Toolbar>
<Editor editor={editor} />
</>
);
}With the code above, the component only has to re-render when the editor switches from being able to bold the current selection and not being able to. Which drastically will reduce re-renders. |
|
Understood, that is super! I think it would make sense to have a selector API on the function MyBubbleMenu() {
const isBold = useCurrentEditor({
selector: editor => !editor.can().setBold(),
});
}
<EditorProvider>
<MyBubbleMenu />
</EditorProvider>Or, with a "useEditorState" hook function MyBubbleMenu({editor}: {editor: Editor}) {
const isBold = useEditorState(editor, {
selector: editor => !editor.can().setBold(),
});
}
function App() {
const editor = useEditor();
return (
<>
<MyBubbleMenu editor={editor} />
<EditorContent editor={editor} />
</>
);
} |
Yep, will be adding something like that to it. Just haven't gotten around to updating this PR yet |
nperez0111
force-pushed
the
fix/react-rerenders
branch
4 times, most recently
from
a26ed74
to
b65ac57
Compare
nperez0111
force-pushed
the
fix/react-rerenders
branch
from
b65ac57
to
607e939
Compare
|
…nstance simultaneously
nperez0111
force-pushed
the
fix/react-rerenders
branch
from
204e7c5
to
f157449
Compare
|
This example proves the difference between the default behavior & the new behavior enabled by the new |
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:
What I've done here is to take a spin on #4579 and base it on a
useSyncExternalStoreinstead (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
selectfunction, you can effectively choose when the component should re-render by returning something different than selected before (inspired byuseSelectorin react-redux)If you include the
equalityFnfunction, you can choose how to compare yourselectfunction's return value (again inspired byuseSelectorin react-redux)Implementation Approach
I've introduced 3 new options to the
useEditorhook (and subsequently the editor provider).immediatelyRenderwhich is to control the new vs. the old behaviorselectwhich is to give the consumer fine-grained control over rendering by selecting the values they care about in re-rendering the editorequalityFnwhich defines how to compare the values that the consumer generates with theselectfunctionWhen not specifying the
immediateRendervalue, if it is detected to be in SSR mode (i.e. no window object) it will be assumed to befalseto not break Next.js users (but printing a message that they should be explicit about this), otherwise it will be assumed to betruereducing 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:
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
immediatelyRenderand 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
useSyncExternalStorebut I also know thatreact-reduxuses a shim to make it compatible with older versions.Checklist
feat: Implement new featureorchore(deps): Update dependencies)Related Issues
#5001