-
Notifications
You must be signed in to change notification settings - Fork 182
fix: restore anchor scrolling on initial page load (CLO-805) #530
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
mrubens
merged 1 commit into
main
from
feature/CLO-805-fix-deep-linking-anchor-scrolling
Feb 9, 2026
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| import type {ClientModule} from '@docusaurus/types'; | ||
|
|
||
| /** | ||
| * Docusaurus's built-in scroll handler skips hash-based scrolling on initial | ||
| * page load (when previousLocation is null). It assumes the browser handles it | ||
| * natively, but React hydration can reset the scroll position before the | ||
| * browser finishes its native anchor scroll. This client module fills that gap | ||
| * by explicitly scrolling to the hash target after hydration settles. | ||
| * | ||
| * @see https://linear.app/roocode/issue/CLO-805 | ||
| */ | ||
| const scrollToAnchorModule: ClientModule = { | ||
| onRouteDidUpdate({location, previousLocation}) { | ||
| // Docusaurus core already handles hash scrolling for subsequent | ||
| // navigations. This module only covers the initial page load case. | ||
| if (previousLocation != null) { | ||
| return; | ||
| } | ||
|
|
||
| const {hash} = location; | ||
| if (!hash) { | ||
| return; | ||
| } | ||
|
|
||
| const id = decodeURIComponent(hash.substring(1)); | ||
| if (!id) { | ||
| return; | ||
| } | ||
|
|
||
| // Wait for the next animation frame so that React hydration has settled | ||
| // and the DOM reflects the final rendered state. | ||
| requestAnimationFrame(() => { | ||
| const element = document.getElementById(id); | ||
| if (element) { | ||
| // scrollIntoView respects the scroll-margin-top set by | ||
| // Docusaurus's anchorTargetStickyNavbar class on headings. | ||
| element.scrollIntoView(); | ||
| return; | ||
| } | ||
|
|
||
| // If the element wasn't found on the first frame (e.g. lazy-loaded | ||
| // content), retry once after a short delay. | ||
| setTimeout(() => { | ||
| const retryElement = document.getElementById(id); | ||
| retryElement?.scrollIntoView(); | ||
| }, 150); | ||
| }); | ||
| }, | ||
| }; | ||
|
|
||
| export default scrollToAnchorModule; | ||
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
decodeURIComponentthrows aURIErrorwhen the hash contains a malformed percent-encoded sequence (e.g.#%ZZ). If someone shares or bookmarks such a URL, the unhandled exception would crash this callback and could prevent other client module hooks from running. Wrapping it in a try-catch keeps things defensive.Fix it with Roo Code or mention @roomote and request a fix.