Skip to content

Improve UX: keep sidebar module visible when navigating docs #60410

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
+16 −0
Open

Improve UX: keep sidebar module visible when navigating docs #60410

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c5645ad
feat(docs): keep sidebar module visible when navigating docs
Botato300 Oct 25, 2025
e0a6c02
doc: optimizes and simplifies the setupSidebarScroll() function
Botato300 Nov 8, 2025
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
16 changes: 16 additions & 0 deletions doc/api_assets/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,20 @@
});
}

function setupSidebarScroll() {
const sidebarLinks = document.querySelectorAll('#column2 a');

let link;
for (link of sidebarLinks) {
if (link.pathname === window.location.pathname) break;
}

if (!link) return;

link.scrollIntoView({ block: 'center' });
}


function bootstrap() {
// Check if we have JavaScript support.
document.documentElement.classList.add('has-js');
Expand All @@ -206,6 +220,8 @@
setupFlavorToggles();

setupCopyButton();

setupSidebarScroll();
}

if (document.readyState === 'loading') {
Expand Down
Loading