-
Notifications
You must be signed in to change notification settings - Fork 17
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Support Strict mode and memoize node view components #142
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
smoores-dev
force-pushed
the
memoizable-take-3
branch
from
October 22, 2024 20:17
889d1ec
to
d3f1191
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The primary goal of these changes is to allow a single node view component to re-render in isolation without affecting the correctness of the view descriptor tree.
Previously, it was required that the entire ProseMirror component tree re-render on every document update in order to maintain the view descriptor tree. The trees are built from the leaves up in
useLayoutEffects
, and the tree was built from scratch on each render cycle.Now, the view descriptors are maintained in refs across renders, and mutated as needed, rather than built from scratch. This fixes an issue with strict mode (#128), since strict mode will render each component twice when it's first mounted. It also allows us to wrap each view component in
React.memo
, which quite dramatically improves the performance of the editor on very long documents. As a case study, working on an editor with the entire contents of Moby Dick in it:Before these changes, each update took over 100ms.
After these changes, each update takes less than 10ms.
On that note, in order to migrate from the
pos
prop to the newgetPos
prop, and in particular to keep thegetPos
reference stable across renders, I had to introduce a few new layers of components inChildNodeViews
. They just encapsulate logic that was in loops before, and add some useRef calls to maintain stable refs togetPos
functions.