mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-22 06:44:35 +00:00
d05323c7b4
This adds labels to the icons and moves them away from the search box. These changes are made together, because they work together, but are based on several complaints: * The [+/-] thing are a Reddit-ism. They don't look like buttons, but look like syntax <https://rust-lang.zulipchat.com/#narrow/stream/266220-t-rustdoc/topic/More.20visual.20difference.20for.20the.20.2B.2F-.20.20Icons>, <https://github.com/rust-lang/rust/issues/59851> (some of these are laundry lists with more suggestions, but they all mention [+/-] looking wrong) * The settings, help, and summary buttons are also too hard to recognize <https://lwn.net/Articles/987070/>, <https://github.com/rust-lang/rust/issues/90310>, <https://github.com/rust-lang/rust/issues/14475#issuecomment-274241997>, <https://internals.rust-lang.org/t/improve-rustdoc-design/12758> ("Not all functionality is self-explanatory, for example the [+] button in the top right corner, the theme picker or the settings button.") The toggle-all and toggle-individual buttons both need done at once, since we want them to look like they go together. This changes them from both being [+/-] to both being arrows. Settings and Help are also migrated, so that the whole group can benefit from being described using actual words. Additionally, the Help button is only shown on SERPs, not all the time. This is done for two major reasons: * Most of what's in there is search-related. The things that aren't are keyboard commands, and the search box tells you about that anyway. Pressing <kbd>?</kbd> will temporarily show the button and its popover. * I'm trading it off by showing the help button, even on mobile. It's useful since you can use the search engine suggestions there. * The three buttons were causing line wrapping on too many desktop layouts.
73 lines
2.7 KiB
Plaintext
73 lines
2.7 KiB
Plaintext
// This test ensures that opening the help page in its own tab works.
|
|
go-to: "file://" + |DOC_PATH| + "/help.html"
|
|
set-window-size: (1000, 1000) // Try desktop size first.
|
|
wait-for: "#help"
|
|
assert-css: ("#help", {"display": "block"})
|
|
assert-css: ("#help dd", {"font-size": "16px"})
|
|
assert-false: "#help-button > a"
|
|
assert-css: ("#help", {"display": "block"})
|
|
compare-elements-property: (".sub", "#help", ["offsetWidth"])
|
|
compare-elements-position: (".sub", "#help", ["x"])
|
|
set-window-size: (500, 1000) // Try mobile next.
|
|
assert-css: ("#help", {"display": "block"})
|
|
compare-elements-property: (".sub", "#help", ["offsetWidth"])
|
|
compare-elements-position: (".sub", "#help", ["x"])
|
|
|
|
// Checking the color of the elements of the help menu.
|
|
show-text: true
|
|
define-function: (
|
|
"check-colors",
|
|
[theme, color, background, box_shadow],
|
|
block {
|
|
// FIXME: no clue why we can't call the `switch-theme` function here...
|
|
set-local-storage: {"rustdoc-theme": |theme|, "rustdoc-use-system-theme": "false"}
|
|
reload:
|
|
assert-css: ("#help kbd", {
|
|
"color": |color|,
|
|
"background-color": |background|,
|
|
"box-shadow": |box_shadow| + " 0px -1px 0px 0px inset",
|
|
}, ALL)
|
|
},
|
|
)
|
|
|
|
call-function: ("check-colors", {
|
|
"theme": "ayu",
|
|
"color": "#c5c5c5",
|
|
"background": "#314559",
|
|
"box_shadow": "#5c6773",
|
|
})
|
|
call-function: ("check-colors", {
|
|
"theme": "dark",
|
|
"color": "#000",
|
|
"background": "#fafbfc",
|
|
"box_shadow": "#c6cbd1",
|
|
})
|
|
call-function: ("check-colors", {
|
|
"theme": "light",
|
|
"color": "#000",
|
|
"background": "#fafbfc",
|
|
"box_shadow": "#c6cbd1",
|
|
})
|
|
|
|
// This test ensures that opening the help popover without switching pages works.
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html?search=a"
|
|
wait-for: "#search-tabs" // Waiting for the search.js to load.
|
|
set-window-size: (1000, 1000) // Only supported on desktop.
|
|
assert-false: "#help"
|
|
click: "#help-button > a"
|
|
assert-css: ("#help", {"display": "block"})
|
|
assert-css: ("#help dd", {"font-size": "16px"})
|
|
click: "#help-button > a"
|
|
assert-css: ("#help", {"display": "none"})
|
|
compare-elements-property-false: (".sub", "#help", ["offsetWidth"])
|
|
compare-elements-position-false: (".sub", "#help", ["x"])
|
|
|
|
// This test ensures that the "the rustdoc book" anchor link within the help popover works.
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html?search=a"
|
|
wait-for: "#search-tabs" // Waiting for the search.js to load.
|
|
set-window-size: (1000, 1000) // Popover only appears when the screen width is >700px.
|
|
assert-false: "#help"
|
|
click: "#help-button > a"
|
|
click: "//*[@id='help']//a[text()='the rustdoc book']"
|
|
wait-for-document-property: ({"URL": "https://doc.rust-lang.org/"}, STARTS_WITH)
|