mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-27 01:04:03 +00:00
f8b92697a1
rustdoc: allow resizing the sidebar / hiding the top bar Fixes #97306 Preview: http://notriddle.com/rustdoc-html-demo-4/sidebar-resize/std/index.html  ## Summary This feature adds: 1. A checkbox to the Settings popover to hide the persistent navigation bar (the sidebar on large viewports and the top bar on small ones). 2. On large viewports, it adds a resize handle to the persistent sidebar. Resizing it into nothing is equivalent to turning off the persistent navigation bar checkbox in Settings. 3. If the navigation bar is hidden, a toolbar button to the left of the search appears. Clicking it brings the navigation bar back. ## Motivation While "mobile mode" is definitely a good default, it's not the only reason people have wanted to hide the sidebar: * Some people use tiling window managers, and don't like rustdoc's current breakpoints. Changing the breakpoints might help with that, but there's no perfect solution, because there's a gap between "huge screen" and "smartphone" where reasonable people can disagree about whether it makes sense for the sidebar to be on-screen. https://github.com/rust-lang/rust/issues/97306 * Some people ask for ways to reduce on-screen clutter because it makes it easier to focus. There's not a media query for that (and if there was, privacy-conscious users would turn it off). https://github.com/rust-lang/rust/issues/59829 This feature is designed to avoid these problems. Resizing the sidebar especially helps, because it provides a way to hide the sidebar without adding a new top-level button (which would add clutter), and it provides a way to make rustdoc play nicer in complex, custom screen layouts. ## Guide and Reference-level explanation On a desktop or laptop with a mouse, resize the sidebar by dragging its right edge. On any browser, including mobile phones, the sticky top bar or side bar can be hidden from the Settings area (the button with the cog wheel, next to the search bar). When it's hidden, a convenient button will appear on the search bar's left. ## Drawbacks This adds more JavaScript code to the render blocking area. ## Rationale and alternatives The most obvious way to allow people to hide the sidebar would have been to let them "manually enter mobile mode." The upside is that it's a feature we already have. The downside is that it's actually really hard to come up with a terse description. Is it: * A Setting that forces desktop viewers to always have the mobile-style top bar? If so, how do we label it? Should it be visible on mobile, and, if so, does it just not do anything? * A persistent hide/show sidebar button, present on desktop, just like on mobile? That's clutter that I'd like to avoid. ## Prior art * The new file browser in GitHub uses a similar divider with a mouse-over indicator * mdBook and macOS Finder both allow you to resize the sidebar to nothing as a gesture to hide it * https://www.nngroup.com/articles/drag-drop/ ## Future possibilities https://rust-lang.zulipchat.com/#narrow/stream/266220-rustdoc/topic/Table.20of.20contents proposes a new, second sidebar (a table of contents). How should it fit in with this feature? Should it be resizeable? Hideable? Can it be accessed on mobile?
92 lines
2.8 KiB
Plaintext
92 lines
2.8 KiB
Plaintext
// The goal of this test is to ensure that the sidebar is working as expected in the source
|
|
// code pages.
|
|
go-to: "file://" + |DOC_PATH| + "/src/test_docs/lib.rs.html"
|
|
show-text: true
|
|
|
|
// First, check the sidebar colors.
|
|
define-function: (
|
|
"check-colors",
|
|
(theme, color, background_color),
|
|
block {
|
|
set-local-storage: {
|
|
"rustdoc-theme": |theme|,
|
|
"rustdoc-use-system-theme": "false",
|
|
}
|
|
reload:
|
|
// Checking results colors.
|
|
assert-css: (".src .sidebar", {
|
|
"color": |color|,
|
|
"background-color": |background_color|
|
|
}, ALL)
|
|
},
|
|
)
|
|
|
|
call-function: (
|
|
"check-colors",
|
|
{
|
|
"theme": "ayu",
|
|
"color": "#c5c5c5",
|
|
"background_color": "#14191f",
|
|
}
|
|
)
|
|
call-function: (
|
|
"check-colors",
|
|
{
|
|
"theme": "dark",
|
|
"color": "#ddd",
|
|
"background_color": "#505050",
|
|
}
|
|
)
|
|
call-function: (
|
|
"check-colors",
|
|
{
|
|
"theme": "light",
|
|
"color": "black",
|
|
"background_color": "#F5F5F5",
|
|
}
|
|
)
|
|
|
|
// Next, desktop mode layout.
|
|
set-window-size: (1100, 800)
|
|
wait-for: "#src-sidebar-toggle"
|
|
// We check that the sidebar isn't expanded and has the expected width.
|
|
assert-css: ("nav.sidebar", {"width": "50px"})
|
|
// We now click on the button to expand the sidebar.
|
|
click: (10, 10)
|
|
// We wait for the sidebar to be expanded.
|
|
wait-for-css: (".src-sidebar-expanded nav.sidebar", {"width": "300px"})
|
|
assert-css: (".src-sidebar-expanded nav.sidebar a", {"font-size": "14px"})
|
|
// We collapse the sidebar.
|
|
click: (10, 10)
|
|
// We ensure that the class has been removed.
|
|
wait-for: "html:not(.src-sidebar-expanded)"
|
|
assert: "nav.sidebar"
|
|
|
|
// Checking that only the path to the current file is "open".
|
|
go-to: "file://" + |DOC_PATH| + "/src/lib2/another_folder/sub_mod/mod.rs.html"
|
|
// First we expand the sidebar again.
|
|
click: (10, 10)
|
|
// We wait for the sidebar to be expanded.
|
|
wait-for-css: (".src-sidebar-expanded nav.sidebar", {"width": "300px"})
|
|
assert: "//*[@class='dir-entry' and @open]/*[text()='lib2']"
|
|
assert: "//*[@class='dir-entry' and @open]/*[text()='another_folder']"
|
|
assert: "//*[@class='dir-entry' and @open]/*[text()='sub_mod']"
|
|
// Only "another_folder" should be "open" in "lib2".
|
|
assert: "//*[@class='dir-entry' and not(@open)]/*[text()='another_mod']"
|
|
// All other trees should be collapsed.
|
|
assert-count: ("//*[@id='src-sidebar']/details[not(text()='lib2') and not(@open)]", 11)
|
|
|
|
// We now switch to mobile mode.
|
|
set-window-size: (600, 600)
|
|
wait-for-css: (".src-sidebar-expanded nav.sidebar", {"left": "0px"})
|
|
// We collapse the sidebar.
|
|
click: (10, 10)
|
|
// We check that the sidebar has been moved off-screen.
|
|
assert-css: ("nav.sidebar", {"left": "-1000px"})
|
|
// We ensure that the class has been removed.
|
|
assert-false: ".src-sidebar-expanded"
|
|
assert: "nav.sidebar"
|
|
|
|
// Check that the topbar is not visible
|
|
assert-false: ".mobile-topbar"
|