refactor: cleanup scroll handlers #5709
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
lex111
added
the
pr: polish
lex111
commented
Oct 15, 2021
| } | ||
| }, | ||
| [location], |
There was a problem hiding this comment.
To check location we now use useLocationChange hook everywhere, this will better distinguish between scroll and location event handlers.
|
|
||
| useEffect(() => { | ||
| // Prevent first effect to trigger the listener on mount |
There was a problem hiding this comment.
This is unnecessary code, it used to be needed to fix #5020, but it is safe to remove now.
|
✔️ [V2] 🔨 Explore the source changes: 8065b89 🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/61694f6c2128540008eb7c2a 😎 Browse the preview: https://deploy-preview-5709--docusaurus-2.netlify.app |
|
⚡️ Lighthouse report for the changes in this PR:
Lighthouse ran on https://deploy-preview-5709--docusaurus-2.netlify.app/ |
|
Size Change: -46 B (0%) Total Size: 841 kB
ℹ️ View Unchanged
|
|
Didn't notice any issue 👍 |
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
This PR tries to unify use of scroll handlers in
useScrollPosition, as there are quite a few non-obvious and unnecessary things right now. Beside that, it improves performance a bit, at least hideable navbar is no longer rendered twice on first mount.It also fixes proper closing of hideable navbar when navigating from search (eg, "docs/next/versioning#docs"):
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
Preview. It's not that simple, you have to check hideable navbar and back-to-top-button.
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.)