fix(html): preserve sidebar scroll when clicking chapter links#3120
Open
leno23 wants to merge 1 commit into
Open
fix(html): preserve sidebar scroll when clicking chapter links#3120leno23 wants to merge 1 commit into
leno23 wants to merge 1 commit into
Conversation
Store the sidebar scrollbox scrollTop on link click and restore it on the next page load. The previous offset-based adjustment used the new page's active link and reset the sidebar to the top. Fixes rust-lang#3081 Co-authored-by: Cursor <cursoragent@cursor.com>
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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
scrollTopinsessionStorageMotivation
In mdBook 0.5+, clicking a chapter in the sidebar often jumped the TOC back to the top (#3081). The previous logic compared the new page’s
.activelink position to a saved offset from the clicked link, which produced incorrect scroll adjustments.This matches the existing GUI test
sidebar-scroll.goml.Notes
Some reports link this to clean/prettified URLs (#3034); this fix addresses scroll preservation for normal sidebar navigation regardless.
Test plan
cargo test --test testsuitesidebar-scroll.goml)Fixes #3081
Made with Cursor