Fix auto-scroll undershooting correction location on initial page load #2238
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
trusktr
reviewed
Sep 25, 2023
| } | ||
| }, 100); | ||
| }); | ||
| } |
There was a problem hiding this comment.
Is this reliable? Does the page go into non-complete ready state on each markdown fetch/render? If not, perhaps we should instead track images (etc) ourself, and wait for load event on all of them. Need to check this out.
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.
Summary
Bug: Navigating to an anchor link on docs with images causes the initial auto-scroll to "undershoot" the correct location. This is because the scroll location is calculated prior to the images loading, so the image heights aren't accounted for in the location calculation.
Fix: Wait for the document to finish loading and then scroll to the location. After scrolling to the location, call
el.scrollIntoView()as a backup.Additional Bug: Auto-scroll on an initial page load does not scroll the appropriate sidebar item into view. This is because
#highlight()is blocked while the Tweezer animation is running and will not scroll the sidebar if the item is already active.Fix: Call
#highlight()after the Tweezer scroll animation is complete with a parameter to force the scroll.Related issue, if any:
#351
#559
What kind of change does this PR introduce?
Bugfix
For any code change,
Does this PR introduce a breaking change?
No
Tested in the following browsers: