Skip to content

Fix keyboard access for sidebar toggle #3078

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
lawrence3699 wants to merge 1 commit into
base: master
Choose a base branch
from
+20 −1
Open

Fix keyboard access for sidebar toggle #3078

Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions crates/mdbook-html/front-end/css/chrome.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,9 @@ html.sidebar-visible #mdbook-menu-bar {
html:not(.js) .left-buttons button {
display: none;
}
html.js #mdbook-sidebar-toggle-nojs {
display: none;
}

.menu-title {
display: inline-block;
Expand Down
2 changes: 2 additions & 0 deletions crates/mdbook-html/front-end/js/book.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -548,6 +548,8 @@ aria-label="Show hidden lines"></button>';
// reflow after updating the display.
sidebar.offsetHeight;
}
sidebarCheckbox.checked = !sidebarCheckbox.checked;
sidebarCheckbox.dispatchEvent(new Event('change'));
});

function showSidebar() {
Expand Down
5 changes: 4 additions & 1 deletion crates/mdbook-html/front-end/templates/index.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,9 +143,12 @@
<div id="mdbook-menu-bar-hover-placeholder"></div>
<div id="mdbook-menu-bar" class="menu-bar sticky">
<div class="left-buttons">
<label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
<label id="mdbook-sidebar-toggle-nojs" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
{{fa "solid" "bars"}}
</label>
<button id="mdbook-sidebar-toggle" class="icon-button" type="button" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
{{fa "solid" "bars"}}
</button>
<button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list">
{{fa "solid" "paintbrush"}}
</button>
Expand Down
11 changes: 11 additions & 0 deletions tests/gui/sidebar.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,17 @@ store-value: (sidebar_storage_value, "mdbook-sidebar")
store-value: (sidebar_storage_hidden_value, "hidden")
store-value: (sidebar_storage_displayed_value, "visible")

focus: "#mdbook-sidebar-toggle"
assert-document-property: {"activeElement"."id": "mdbook-sidebar-toggle"}
press-key: 'Enter'
wait-for-css: ("#mdbook-sidebar", {"display": "none"})
assert-local-storage: {|sidebar_storage_value|: |sidebar_storage_hidden_value|}
press-key: 'Enter'
wait-for-css-false: ("#mdbook-sidebar", {"display": "none"})
// `transform` is 0.3s so we need to wait a bit (0.5s) to ensure the animation is done.
wait-for: 5000
assert-local-storage: {|sidebar_storage_value|: |sidebar_storage_displayed_value|}

define-function: (
"hide-sidebar",
[],
Expand Down