Skip to content

Keep active sidebar item visible across navigation#380

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

Closed
ehfeng wants to merge 3 commits into from
Closed

Keep active sidebar item visible across navigation #380

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8af0335
Keep active sidebar item visible across navigation
ehfeng May 27, 2026
5d56cf8
Trim explanatory comments in sidebar-scroll.js
ehfeng May 27, 2026
e2ef311
Trigger sidebar scroll on data-current-path mutation
ehfeng May 27, 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
50 changes: 50 additions & 0 deletions sidebar-scroll.js
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
(function () {
if (typeof window === "undefined") return;

// Mintlify's markup is not a stable contract; take the first scrollable match.
function findSidebar() {
var candidates = document.querySelectorAll(
"aside, nav[aria-label='Sidebar'], aside[aria-label='Sidebar'], #sidebar"
);
for (var i = 0; i < candidates.length; i++) {
if (candidates[i].scrollHeight > candidates[i].clientHeight + 1) {
return candidates[i];
}
}
return null;
}

function showActive() {
var sb = findSidebar();
if (!sb) return;
var link = sb.querySelector(
"a[aria-current='page'], a[aria-current='true'], a[data-active='true']"
);
// Guard against acting on the previous page's link before the DOM updates.
if (!link || link.pathname !== location.pathname) return;

@cursorcursorBotMay 27, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No retry after race condition guard causes silent failure

Medium Severity

On SPA navigation, data-current-path on <html> triggers the MutationObserver, which schedules a single requestAnimationFrame(showActive). If Mintlify's React render cycle hasn't yet updated aria-current on sidebar links by the time that frame fires, the guard on line 24 (link.pathname !== location.pathname) correctly bails out to avoid acting on the old link — but there is no retry. The feature silently becomes a no-op for that navigation. The PR description mentions "polling until the sidebar mounts plus one 150ms re-apply" but neither mechanism is actually implemented.

Additional Locations (1)
Fix in CursorFix in Web

Reviewed by Cursor Bugbot for commit e2ef311. Configure here.


var sbRect = sb.getBoundingClientRect();
var linkRect = link.getBoundingClientRect();
var margin = 24;

if (linkRect.top < sbRect.top + margin) {
sb.scrollTop -= sbRect.top + margin - linkRect.top;
} else if (linkRect.bottom > sbRect.bottom - margin) {
sb.scrollTop += linkRect.bottom - (sbRect.bottom - margin);
}
}

// Mintlify has no navigation event, but it rewrites data-current-path on
// <html> on every client-side route change. That mutation is our signal.
var html = document.documentElement;
var last = html.getAttribute("data-current-path");
new MutationObserver(function () {
var cur = html.getAttribute("data-current-path");
if (cur === last) return;
last = cur;
requestAnimationFrame(showActive);
}).observe(html, { attributes: true, attributeFilter: ["data-current-path"] });

if (document.readyState === "complete") showActive();
else window.addEventListener("load", showActive);
})();
Loading