Skip to content

docs: scroll active sidebar link into view on crosslink navigation #34

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.

Sign up for GitHub

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
rachaelrenk merged 3 commits into from
May 8, 2026
+17 −0
Merged

docs: scroll active sidebar link into view on crosslink navigation #34

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7230c54
docs: scroll active sidebar link into view on crosslink navigation
rachaelrenk May 7, 2026
7e1a40f
Merge remote-tracking branch 'origin/main' into docs/migration-ff/sid…
rachaelrenk May 7, 2026
a8f371f
docs: center active sidebar link instead of scrolling to edge
rachaelrenk May 8, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions src/components/CustomSidebar.astro
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,3 +33,20 @@ import KapaLauncher from './KapaLauncher.astro';
<StarlightSidebarTopicsSidebar />
</div>
<Default><slot /></Default>

<!-- Scroll the active sidebar link into view after page load.
Starlight's SidebarPersister restores scrollTop from sessionStorage,
but when navigating via crosslink to a different section, the restored
position is stale and the active link ends up off-screen. This script
runs after Starlight's inline restoration (which fires synchronously
before DOMContentLoaded) and uses `block: 'center'` to place the
active link in the middle of the sidebar viewport for orientation.
Desktop only -- on mobile the sidebar is a drawer that scrolls
independently. -->
<script is:inline>
(() => {
if (!matchMedia('(min-width: 50em)').matches) return;
const active = document.querySelector('.sidebar-content a[aria-current="page"]');
if (active) active.scrollIntoView({ block: 'center' });
})();
</script>
Loading