Skip to content
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

Automatically close the sidebar when navigating sections on mobile #2097

Merged
merged 1 commit into from
Mar 18, 2025
Merged

Automatically close the sidebar when navigating sections on mobile #2097

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions assets/js/sidebar/sidebar-drawer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ if (!isEmbedded) {
// We observe on mousedown because we only care about user resize.
sidebar.addEventListener('mousedown', () => resizeObserver.observe(sidebar))
sidebar.addEventListener('mouseup', () => resizeObserver.unobserve(sidebar))

window.addEventListener('hashchange', maybeCloseSidebarOnNavigate)
}

function setDefaultSidebarState () {
Expand Down Expand Up @@ -114,3 +116,13 @@ function transitionSidebar (open) {
export function openSidebar () {
return transitionSidebar(true)
}

/**
* Closes the sidebar on small screens when navigating between sections
* on the page, for consistency with full page transitions
*/
function maybeCloseSidebarOnNavigate () {
if (smallScreenQuery.matches && isSidebarOpen()) {
transitionSidebar(false)
}
}