Skip to content

Improve accessibility for source sidebar collapse/expand button #119049

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
wants to merge 3 commits into from
Closed

Improve accessibility for source sidebar collapse/expand button #119049

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
65930aa
Simplify source pages sidebar handling
GuillaumeGomez Dec 16, 2023
e9faeea
Update test for source sidebar button change
GuillaumeGomez Dec 16, 2023
43a45e0
Improve accessibility for source sidebar collapse/expand button
GuillaumeGomez Dec 17, 2023
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
38 changes: 24 additions & 14 deletions src/librustdoc/html/static/css/rustdoc.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1540,6 +1540,30 @@ a.tooltip:hover::after {
align-items: stretch;
z-index: 10;
}
#src-sidebar-toggle > button {
font-size: inherit;
font-weight: bold;
background: none;
color: inherit;
text-align: center;
border: none;
outline: none;
flex: 1 1;
/* iOS button gradient: https://stackoverflow.com/q/5438567 */
-webkit-appearance: none;
opacity: 1;
display: block;
}
#src-sidebar-toggle > button.collapse {
display: none;
}
.src-sidebar-expanded #src-sidebar-toggle > button.expand {
display: none;
}
.src-sidebar-expanded #src-sidebar-toggle > button.collapse {
display: block;
}

#src-sidebar {
width: 100%;
overflow: auto;
Expand All @@ -1557,20 +1581,6 @@ a.tooltip:hover::after {
#src-sidebar div.files > a.selected {
background-color: var(--src-sidebar-background-selected);
}
#src-sidebar-toggle > button {
font-size: inherit;
font-weight: bold;
background: none;
color: inherit;
text-align: center;
border: none;
outline: none;
flex: 1 1;
/* iOS button gradient: https://stackoverflow.com/q/5438567 */
-webkit-appearance: none;
opacity: 1;
}

#settings-menu, #help-button {
margin-left: 4px;
display: flex;
Expand Down
35 changes: 12 additions & 23 deletions src/librustdoc/html/static/js/src-script.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,48 +71,37 @@ function createDirEntry(elem, parent, fullPath, hasFoundFile) {
return hasFoundFile;
}

let toggleLabel;

function getToggleLabel() {
toggleLabel = toggleLabel || document.querySelector("#src-sidebar-toggle button");
return toggleLabel;
}

window.rustdocCloseSourceSidebar = () => {
removeClass(document.documentElement, "src-sidebar-expanded");
getToggleLabel().innerText = ">";
updateLocalStorage("source-sidebar-show", "false");
};

window.rustdocShowSourceSidebar = () => {
addClass(document.documentElement, "src-sidebar-expanded");
getToggleLabel().innerText = "<";
updateLocalStorage("source-sidebar-show", "true");
};

function toggleSidebar() {
const child = this.parentNode.children[0];
if (child.innerText === ">") {
window.rustdocShowSourceSidebar();
} else {
window.rustdocCloseSourceSidebar();
}
function createButton(className, text, onclick, ariaLabel) {
const button = document.createElement("button");
button.className = className;
button.innerText = text;
button.onclick = onclick;
button.setAttribute("aria-label", ariaLabel);
return button;
}

function createSidebarToggle() {
const sidebarToggle = document.createElement("div");
sidebarToggle.id = "src-sidebar-toggle";

const inner = document.createElement("button");
sidebarToggle.appendChild(
createButton("expand", ">", window.rustdocShowSourceSidebar, "Expand source sidebar"));
sidebarToggle.appendChild(
createButton("collapse", "<", window.rustdocCloseSourceSidebar, "Collapse source sidebar"));

if (getCurrentValue("source-sidebar-show") === "true") {
inner.innerText = "<";
} else {
inner.innerText = ">";
window.rustdocShowSourceSidebar();
}
inner.onclick = toggleSidebar;

sidebarToggle.appendChild(inner);
return sidebarToggle;
}

Expand Down
4 changes: 2 additions & 2 deletions tests/rustdoc-gui/sidebar-source-code-display.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ define-function: (
// Without hover or focus.
assert-css: ("#src-sidebar-toggle > button", {"background-color": |background_toggle|})
// With focus.
focus: "#src-sidebar-toggle > button"
focus: "#src-sidebar-toggle > button.collapse"
assert-css: (
"#src-sidebar-toggle > button:focus",
{"background-color": |background_toggle_hover|},
)
focus: ".search-input"
// With hover.
move-cursor-to: "#src-sidebar-toggle > button"
move-cursor-to: "#src-sidebar-toggle > button.collapse"
assert-css: (
"#src-sidebar-toggle > button:hover",
{"background-color": |background_toggle_hover|},
Expand Down