[docs] fix scroll into view for sidebar #28030
Merged
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
salazarm
reviewed
Mar 20, 2025
|
Does this handle scrolling when you switch pages? If not we still need to hook into that |
salazarm
approved these changes
Mar 20, 2025
Good call! Thought I'd be able to remove these, but re-introduced: And confirmed it's working as expected. Thanks @salazarm . |
salazarm
reviewed
Mar 20, 2025
prha
pushed a commit
that referenced
this pull request
Mar 21, 2025
## Summary & Motivation
Closes DOC-888.
Introduces plugin to automatically `scrollIntoView()`the active left
sidebar item.
```
plugins: [
require.resolve('./src/plugins/sidebar-scroll-into-view'),
],
```
This is a temporary workaround until it is re-introduced upstream
(pending since 2022): [see source
code](https://github.com/facebook/docusaurus/blob/f31bfec3c9a7e9e032a36ccd9b405b0e2c2f6957/packages/docusaurus-theme-common/src/hooks/useTOCHighlight.ts#L158).
* facebook/docusaurus#6748
* facebook/docusaurus#6319
* facebook/docusaurus#7980
## How I Tested These Changes
Confirmed working as expected on localhost.
## Changelog
- [docs] automatically scroll left sidebar into view on direct link to
documentation
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 & Motivation
Closes DOC-888.
Introduces plugin to automatically
scrollIntoView()the active left sidebar item.This is a temporary workaround until it is re-introduced upstream (pending since 2022): see source code.
How I Tested These Changes
Confirmed working as expected on localhost.
Changelog