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.
74 lines
2.8 KiB
Plaintext
74 lines
2.8 KiB
Plaintext
// Checks that the documentation toggles have the correct position, style and work as expected.
|
|
include: "utils.goml"
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
|
|
assert-attribute: ("#main-content > details.top-doc", {"open": ""})
|
|
assert-text: ("#toggle-all-docs", "Summary")
|
|
click: "#toggle-all-docs"
|
|
wait-for: 50
|
|
// This is now collapsed so there shouldn't be the "open" attribute on details.
|
|
assert-attribute-false: ("#main-content > details.top-doc", {"open": ""})
|
|
assert-text: ("#toggle-all-docs", "Show all")
|
|
assert-css: (
|
|
"#main-content > details.top-doc > summary",
|
|
{"font-family": '"Fira Sans", Arial, NanumBarunGothic, sans-serif'},
|
|
)
|
|
click: "#toggle-all-docs"
|
|
// Not collapsed anymore so the "open" attribute should be back.
|
|
wait-for-attribute: ("#main-content > details.top-doc", {"open": ""})
|
|
assert-text: ("#toggle-all-docs", "Summary")
|
|
|
|
// Check that it works on non-module pages as well.
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/struct.Foo.html"
|
|
// We first check that everything is visible.
|
|
assert-text: ("#toggle-all-docs", "Summary")
|
|
assert-attribute: ("#implementations-list details.toggle", {"open": ""}, ALL)
|
|
assert-attribute: ("#trait-implementations-list details.toggle", {"open": ""}, ALL)
|
|
assert-attribute-false: (
|
|
"#blanket-implementations-list > details.toggle",
|
|
{"open": ""},
|
|
ALL,
|
|
)
|
|
|
|
// We collapse them all.
|
|
click: "#toggle-all-docs"
|
|
wait-for-text: ("#toggle-all-docs", "Show all")
|
|
// We check that all <details> are collapsed (except for the impl block ones).
|
|
assert-attribute-false: ("details.toggle:not(.implementors-toggle)", {"open": ""}, ALL)
|
|
assert-attribute: ("#implementations-list > details.implementors-toggle", {"open": ""})
|
|
// We now check that the other impl blocks are collapsed.
|
|
assert-attribute-false: (
|
|
"#blanket-implementations-list > details.toggle.implementors-toggle",
|
|
{"open": ""},
|
|
ALL,
|
|
)
|
|
// We open them all again.
|
|
click: "#toggle-all-docs"
|
|
wait-for-text: ("#toggle-all-docs", "Summary")
|
|
assert-attribute: ("details.toggle", {"open": ""}, ALL)
|
|
|
|
// Checking the toggles style.
|
|
show-text: true
|
|
define-function: (
|
|
"check-color",
|
|
[theme, filter],
|
|
block {
|
|
call-function: ("switch-theme", {"theme": |theme|})
|
|
|
|
assert-css: ("details.toggle > summary::before", {
|
|
"opacity": "0.5",
|
|
"filter": |filter|,
|
|
}, ALL)
|
|
move-cursor-to: "details.toggle summary"
|
|
assert-css: ("details.toggle > summary:hover::before", {
|
|
"opacity": "1",
|
|
"filter": |filter|,
|
|
})
|
|
// moving the cursor somewhere else to not mess with next function calls.
|
|
move-cursor-to: ".search-input"
|
|
},
|
|
)
|
|
|
|
call-function: ("check-color", {"theme": "ayu", "filter": "invert(1)"})
|
|
call-function: ("check-color", {"theme": "dark", "filter": "invert(1)"})
|
|
call-function: ("check-color", {"theme": "light", "filter": "none"})
|