perf(v2): avoid rerender of sidebar items while scrolling #4603
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
lex111
added
the
pr: performance
|
[V1] Built with commit d588f60 |
|
[V2] Built with commit d588f60 |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-4603--docusaurus-2.netlify.app/ |
|
Size Change: 0 B Total Size: 578 kB ℹ️ View Unchanged
|
|
Thanks That will help but not 100% sure it totally fixes the problem. Will look at this soon |
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.
Motivation
Should fix #4589
Currently we use the scroll event to adjust the correct height of the doc sidebar when displaying the announcement bar. To do this we toggle the class if the user scrolls to the top of a page, which in turn causes the while DocSidebar component to be re-rendered at this moment. Since only items in this component are the most memory-consuming elements, I propose to memoize them to mitigate that issue.
docusaurus/packages/docusaurus-theme-classic/src/theme/DocSidebar/index.tsx
Lines 199 to 201 in f12e8b5
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
See To Reproduce section in #4589
Related PRs
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)