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

rustdoc: name the source page sidebar-toggle #src-sidebar-toggle #105764

Merged
merged 1 commit into from
Dec 16, 2022
Merged

rustdoc: name the source page sidebar-toggle #src-sidebar-toggle #105764

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
20 changes: 10 additions & 10 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 @@ -396,15 +396,15 @@ img {
overflow-y: hidden;
}

.source .sidebar, #sidebar-toggle, #source-sidebar {
.source .sidebar, #src-sidebar-toggle, #source-sidebar {
background-color: var(--sidebar-background-color);
}

#sidebar-toggle > button:hover, #sidebar-toggle > button:focus {
#src-sidebar-toggle > button:hover, #src-sidebar-toggle > button:focus {
background-color: var(--sidebar-background-color-hover);
}

.source .sidebar > *:not(#sidebar-toggle) {
.source .sidebar > *:not(#src-sidebar-toggle) {
visibility: hidden;
}

Expand All @@ -413,7 +413,7 @@ img {
flex-basis: 300px;
}

.source-sidebar-expanded .source .sidebar > *:not(#sidebar-toggle) {
.source-sidebar-expanded .source .sidebar > *:not(#src-sidebar-toggle) {
visibility: visible;
}

Expand Down Expand Up @@ -1291,7 +1291,7 @@ a.test-arrow:hover {
font-size: 1rem;
}

#sidebar-toggle {
#src-sidebar-toggle {
position: sticky;
top: 0;
left: 0;
Expand Down Expand Up @@ -1320,7 +1320,7 @@ a.test-arrow:hover {
#source-sidebar div.files > a.selected {
background-color: var(--source-sidebar-background-selected);
}
#sidebar-toggle > button {
#src-sidebar-toggle > button {
font-size: inherit;
font-weight: bold;
background: none;
Expand Down Expand Up @@ -1722,7 +1722,7 @@ in storage.js
left: -11px;
}

#sidebar-toggle {
#src-sidebar-toggle {
position: fixed;
left: 1px;
top: 100px;
Expand All @@ -1736,7 +1736,7 @@ in storage.js
border-left: 0;
}

.source-sidebar-expanded #sidebar-toggle {
.source-sidebar-expanded #src-sidebar-toggle {
left: unset;
top: unset;
width: unset;
Expand Down Expand Up @@ -1847,10 +1847,10 @@ in storage.js
width: 35px;
}

#sidebar-toggle {
#src-sidebar-toggle {
top: 10px;
}
.source-sidebar-expanded #sidebar-toggle {
.source-sidebar-expanded #src-sidebar-toggle {
top: unset;
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/librustdoc/html/static/js/source-script.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ function toggleSidebar() {

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

const inner = document.createElement("button");

Expand Down
4 changes: 2 additions & 2 deletions src/test/rustdoc-gui/code-sidebar-toggle.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// This test checks that the source code pages sidebar toggle is working as expected.
goto: "file://" + |DOC_PATH| + "/test_docs/index.html"
click: ".srclink"
wait-for: "#sidebar-toggle"
click: "#sidebar-toggle"
wait-for: "#src-sidebar-toggle"
click: "#src-sidebar-toggle"
fail: true
assert-css: ("#source-sidebar", { "left": "-300px" })
2 changes: 1 addition & 1 deletion src/test/rustdoc-gui/cursor.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,4 +21,4 @@ assert-css: (".sidebar-menu-toggle", {"cursor": "pointer"})

// the sidebar toggle button on the source code pages
goto: "file://" + |DOC_PATH| + "/src/lib2/lib.rs.html"
assert-css: ("#sidebar-toggle > button", {"cursor": "pointer"})
assert-css: ("#src-sidebar-toggle > button", {"cursor": "pointer"})
44 changes: 22 additions & 22 deletions src/test/rustdoc-gui/sidebar-source-code-display.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,18 @@
javascript: false
goto: "file://" + |DOC_PATH| + "/src/test_docs/lib.rs.html"
// Since the javascript is disabled, there shouldn't be a toggle.
assert-false: "#sidebar-toggle"
assert-false: "#src-sidebar-toggle"
wait-for-css: (".sidebar", {"display": "none"})

// Let's retry with javascript enabled.
javascript: true
reload:
wait-for: "#sidebar-toggle"
assert-css: ("#sidebar-toggle", {"visibility": "visible"})
assert-css: (".sidebar > *:not(#sidebar-toggle)", {"visibility": "hidden"})
wait-for: "#src-sidebar-toggle"
assert-css: ("#src-sidebar-toggle", {"visibility": "visible"})
assert-css: (".sidebar > *:not(#src-sidebar-toggle)", {"visibility": "hidden"})
// Let's expand the sidebar now.
click: "#sidebar-toggle"
wait-for-css: ("#sidebar-toggle", {"visibility": "visible"})
click: "#src-sidebar-toggle"
wait-for-css: ("#src-sidebar-toggle", {"visibility": "visible"})

// We now check that opening the sidebar and clicking a link will leave it open.
// The behavior here on desktop is different than the behavior on mobile,
Expand All @@ -38,25 +38,25 @@ define-function: (
[
("local-storage", {"rustdoc-theme": |theme|, "rustdoc-use-system-theme": "false"}),
("reload"),
("wait-for-css", ("#sidebar-toggle", {"visibility": "visible"})),
("wait-for-css", ("#src-sidebar-toggle", {"visibility": "visible"})),
("assert-css", (
"#source-sidebar details[open] > .files a.selected",
{"color": |color_hover|, "background-color": |background|},
)),

// Without hover or focus.
("assert-css", ("#sidebar-toggle > button", {"background-color": |background_toggle|})),
("assert-css", ("#src-sidebar-toggle > button", {"background-color": |background_toggle|})),
// With focus.
("focus", "#sidebar-toggle > button"),
("focus", "#src-sidebar-toggle > button"),
("assert-css", (
"#sidebar-toggle > button:focus",
"#src-sidebar-toggle > button:focus",
{"background-color": |background_toggle_hover|},
)),
("focus", ".search-input"),
// With hover.
("move-cursor-to", "#sidebar-toggle > button"),
("move-cursor-to", "#src-sidebar-toggle > button"),
("assert-css", (
"#sidebar-toggle > button:hover",
"#src-sidebar-toggle > button:hover",
{"background-color": |background_toggle_hover|},
)),

Expand Down Expand Up @@ -151,16 +151,16 @@ call-function: ("check-colors", {
size: (500, 700)
reload:
// Waiting for the sidebar to be displayed...
wait-for-css: ("#sidebar-toggle", {"visibility": "visible"})
wait-for-css: ("#src-sidebar-toggle", {"visibility": "visible"})

// We now check it takes the full size of the display.
assert-property: ("body", {"clientWidth": "500", "clientHeight": "700"})
assert-property: (".sidebar", {"clientWidth": "500", "clientHeight": "700"})

// We now check the display of the toggle once the sidebar is expanded.
assert-property: ("#sidebar-toggle", {"clientWidth": "500", "clientHeight": "39"})
assert-property: ("#src-sidebar-toggle", {"clientWidth": "500", "clientHeight": "39"})
assert-css: (
"#sidebar-toggle",
"#src-sidebar-toggle",
{
"border-top-width": "0px",
"border-right-width": "0px",
Expand All @@ -170,36 +170,36 @@ assert-css: (
)

// We now check that the scroll position is kept when opening the sidebar.
click: "#sidebar-toggle"
click: "#src-sidebar-toggle"
wait-for-css: (".sidebar", {"width": "0px"})
// We scroll to line 117 to change the scroll position.
scroll-to: '//*[@id="117"]'
assert-window-property: {"pageYOffset": "2542"}
// Expanding the sidebar...
click: "#sidebar-toggle"
click: "#src-sidebar-toggle"
wait-for-css: (".sidebar", {"width": "500px"})
click: "#sidebar-toggle"
click: "#src-sidebar-toggle"
wait-for-css: (".sidebar", {"width": "0px"})
// The "scrollTop" property should be the same.
assert-window-property: {"pageYOffset": "2542"}

// We now check that the scroll position is restored if the window is resized.
size: (500, 700)
click: "#sidebar-toggle"
click: "#src-sidebar-toggle"
wait-for-css: ("#source-sidebar", {"visibility": "visible"})
assert-window-property: {"pageYOffset": "0"}
size: (900, 900)
assert-window-property: {"pageYOffset": "2542"}
size: (500, 700)
click: "#sidebar-toggle"
click: "#src-sidebar-toggle"
wait-for-css: ("#source-sidebar", {"visibility": "hidden"})

// We now check that opening the sidebar and clicking a link will close it.
// The behavior here on mobile is different than the behavior on desktop,
// but common sense dictates that if you have a list of files that fills the entire screen, and
// you click one of them, you probably want to actually see the file's contents, and not just
// make it the current selection.
click: "#sidebar-toggle"
click: "#src-sidebar-toggle"
wait-for-css: ("#source-sidebar", {"visibility": "visible"})
assert-local-storage: {"rustdoc-source-sidebar-show": "true"}
click: ".sidebar a.selected"
Expand All @@ -210,6 +210,6 @@ assert-local-storage: {"rustdoc-source-sidebar-show": "false"}
size: (1000, 1000)
wait-for-css: ("#source-sidebar", {"visibility": "hidden"})
assert-local-storage: {"rustdoc-source-sidebar-show": "false"}
click: "#sidebar-toggle"
click: "#src-sidebar-toggle"
wait-for-css: ("#source-sidebar", {"visibility": "visible"})
assert-local-storage: {"rustdoc-source-sidebar-show": "true"}
2 changes: 1 addition & 1 deletion src/test/rustdoc-gui/source-code-page.goml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ assert-document-property: ({"URL": "/lib.rs.html"}, ENDS_WITH)
// Checking the source code sidebar.

// First we "open" it.
click: "#sidebar-toggle"
click: "#src-sidebar-toggle"
assert: ".source-sidebar-expanded"

// We check that the first entry of the sidebar is collapsed
Expand Down