MAINT: Simplify toc scrolling behavior #448
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
|
Will leave this one open a bit to see if others have thoughts on the slightly new behavior. Maybe @AakashGfude wants to give it a look since he's going to do a deeper dive on the theme infrastructure? |
for more information, see https://pre-commit.ci
for more information, see https://pre-commit.ci
|
OK I got the interactionobserver working for the scroll behavior as well, so this PR no longer changes the default style of pages, it only improves the "watching" behavior for margin content. I think that this is good to go |
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.
This simplifies the logic behind our scrolling behavior so that we are relying on a less-opaque and a more performant method for deciding when to hide the Table of Contents.
Old method: The way we currently do this is by setting up a callback that fires every time somebody scrolls, calculates the vertical position of every margin element, calculates whether it overlaps with the table of contents, and hides the TOC if they overlap.
New method: Uses the Intersection Observer API to detect whether an element is on screen. This will only fire when an elements visibility has changed, not on every scroll. This should help performance a decent amount, and is a less hacky way to do things in general.