Fix ReadTheDocs TOC scrolling to properly save scrollbar position #145
Conversation
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.
Fixes #147
The scroll bar on ReadTheDocs is supposed to save the scroll bar position and restore it across pages, and it is using
window.savedScrollPositionto do so.While this solution was working in my testing before merging it in #132, it does not work in practice now for some reason.
This changes the save/restore logic to use sessionStorage instead, and also saves/restores the exact position of the page in the viewport, so even the case where the exact scrollbar position cannot be reused it still gets restored to the correct position.
The result can be previewed at https://shader-slanggithubio-aidanfnv-wip.readthedocs.io/en/fix-rtd-toc-scrolling-bug/, and I have confirmed that it is definitely working as expected there.