fix(docs): stop the sidebar from jumping on every nav click - #511
Merged
Conversation
The scroll-into-view effect (from #507) unconditionally scrolled the active sidebar item to 1/3 from the top on every page mount. Since navigation is a full page load, the whole sidebar visibly jumped after EVERY nav click — even when the clicked item was already on screen (reported as a layout shift). Use nearest-edge semantics instead: only adjust scrollTop when the active item is outside the visible area (48px margin), bringing it just into view. An already-visible item leaves the scroll position untouched, so clicking between visible pages no longer shifts anything. Deep links into long sidebars still reveal the active item. Also skips the adjustment when the item has no box (inside a collapsed group).
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7561f4dee0
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
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
1 participant
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
Reported via screen recording: clicking any sidebar nav item makes the whole sidebar visibly jump (layout shift).
Root cause: the scroll-into-view effect from #507 unconditionally scrolled the active sidebar item to 1/3 from the top on every page mount. Since docs navigation is a full page load, the sidebar re-scrolled after every click — even when the clicked item was already fully visible.
Fix — nearest-edge semantics:
Deep links into long sidebars still reveal the highlighted item (the effect's original purpose); clicking between visible pages no longer shifts anything.
Verification
yarn buildgreen