Skip to content

fix: enhance accessibility for sidebar toggle button #2604

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
merged 3 commits into from
Sep 18, 2025
Merged

fix: enhance accessibility for sidebar toggle button #2604

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
99c3695
fix: enhance accessibility for sidebar toggle button
sy-records Sep 15, 2025
a6c9415
fix: improve accessibility of sidebar toggle button
sy-records Sep 16, 2025
4cf45ee
fix: refine accessibility attributes for sidebar toggle button
sy-records Sep 17, 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
6 changes: 4 additions & 2 deletions src/core/event/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -548,9 +548,11 @@ export function Events(Base) {

// Set aria-expanded attribute
ariaElms.forEach(toggleElm => {
const expanded = force ?? sidebarElm.classList.contains('show');
toggleElm.setAttribute('aria-expanded', expanded);
toggleElm.setAttribute(
'aria-expanded',
force ?? sidebarElm.classList.contains('show'),
'aria-label',
expanded ? 'Hide primary navigation' : 'Show primary navigation',
);
});

Expand Down
2 changes: 1 addition & 1 deletion src/core/render/tpl.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ export function main(config) {
? ''
: `
<button class="sidebar-toggle" tabindex="-1" title="Press \\ to toggle">
<div class="sidebar-toggle-button" tabindex="0" aria-label="Toggle primary navigation" aria-keyshortcuts="\\" aria-controls="__sidebar">
<div class="sidebar-toggle-button" tabindex="0" aria-label="Hide primary navigation" aria-keyshortcuts="Use shortcut key \\" aria-controls="__sidebar" role="button">
<span></span><span></span><span></span>
</div>
</button>
Expand Down
Loading