mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-25 16:24:46 +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.
234 lines
10 KiB
Plaintext
234 lines
10 KiB
Plaintext
// Checks multiple things on the sidebar display (width of its elements, colors, etc).
|
|
include: "utils.goml"
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
|
|
assert-property: (".sidebar", {"clientWidth": "200"})
|
|
show-text: true
|
|
|
|
// First, check the sidebar colors.
|
|
define-function: (
|
|
"check-colors",
|
|
[theme, color, background_color],
|
|
block {
|
|
call-function: ("switch-theme", {"theme": |theme|})
|
|
// Checking results colors.
|
|
assert-css: (".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",
|
|
}
|
|
)
|
|
|
|
call-function: ("switch-theme", {"theme": "light"})
|
|
|
|
assert-text: (".sidebar > .sidebar-crate > h2 > a", "test_docs")
|
|
// Crate root has no "location" element
|
|
assert-count: (".sidebar .location", 0)
|
|
assert-count: (".sidebar h2", 1)
|
|
assert-text: ("#all-types", "All Items")
|
|
assert-css: ("#all-types", {"color": "#356da4"})
|
|
// We check that we have the crates list and that the "current" on is "test_docs".
|
|
assert-text: (".sidebar-elems ul.crate > li.current > a", "test_docs")
|
|
// And we're also supposed to have the list of items in the current module.
|
|
assert-text: (".sidebar-elems section ul > li:nth-child(1)", "Re-exports")
|
|
assert-text: (".sidebar-elems section ul > li:nth-child(2)", "Modules")
|
|
assert-text: (".sidebar-elems section ul > li:nth-child(3)", "Macros")
|
|
assert-text: (".sidebar-elems section ul > li:nth-child(4)", "Structs")
|
|
assert-text: (".sidebar-elems section ul > li:nth-child(5)", "Enums")
|
|
assert-text: (".sidebar-elems section ul > li:nth-child(6)", "Constants")
|
|
assert-text: (".sidebar-elems section ul > li:nth-child(7)", "Traits")
|
|
assert-text: (".sidebar-elems section ul > li:nth-child(8)", "Functions")
|
|
assert-text: (".sidebar-elems section ul > li:nth-child(9)", "Type Aliases")
|
|
assert-text: (".sidebar-elems section ul > li:nth-child(10)", "Unions")
|
|
assert-text: (".sidebar-elems section ul > li:nth-child(11)", "Keywords")
|
|
assert-text: ("#structs + .item-table .item-name > a", "Foo")
|
|
click: "#structs + .item-table .item-name > a"
|
|
|
|
// PAGE: struct.Foo.html
|
|
assert-count: (".sidebar .sidebar-crate", 1)
|
|
assert-count: (".sidebar .location", 1)
|
|
assert-count: (".sidebar h2", 3)
|
|
assert-text: (".sidebar-elems ul.block > li.current > a", "Foo")
|
|
// We check that there is no crate listed outside of the top level.
|
|
assert-false: ".sidebar-elems > .crate"
|
|
|
|
click: ".sidebar-elems section .block li > a"
|
|
assert-property-false: ("html", {"scrollTop": "0"})
|
|
|
|
click: ".sidebar h2.location a"
|
|
assert-property: ("html", {"scrollTop": "0"})
|
|
|
|
// We now go back to the crate page to click on the "lib2" crate link.
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
|
|
assert-property: (".sidebar", {"clientWidth": "200"})
|
|
assert-css: (".sidebar-elems ul.crate > li:first-child > a", {"color": "#356da4"})
|
|
click: ".sidebar-elems ul.crate > li:first-child > a"
|
|
|
|
// PAGE: lib2/index.html
|
|
go-to: "file://" + |DOC_PATH| + "/lib2/index.html"
|
|
assert-property: (".sidebar", {"clientWidth": "200"})
|
|
assert-text: (".sidebar > .sidebar-crate > h2 > a", "lib2")
|
|
assert-count: (".sidebar .location", 0)
|
|
// We check that we have the crates list and that the "current" on is now "lib2".
|
|
assert-text: (".sidebar-elems ul.crate > li.current > a", "lib2")
|
|
// We now go to the "foobar" function page.
|
|
assert-text: (".sidebar-elems > section ul.block > li:nth-child(1)", "Modules")
|
|
assert-text: (".sidebar-elems > section ul.block > li:nth-child(2)", "Structs")
|
|
assert-text: (".sidebar-elems > section ul.block > li:nth-child(3)", "Traits")
|
|
assert-text: (".sidebar-elems > section ul.block > li:nth-child(4)", "Functions")
|
|
assert-text: (".sidebar-elems > section ul.block > li:nth-child(5)", "Type Aliases")
|
|
assert-text: ("#functions + .item-table .item-name > a", "foobar")
|
|
click: "#functions + .item-table .item-name > a"
|
|
|
|
// PAGE: fn.foobar.html
|
|
// In items containing no items (like functions or constants) and in modules, we have no
|
|
// "location" elements. Only the crate and optional parent module.
|
|
// This page, being directly below the crate, only has its heading.
|
|
assert-text: (".sidebar > .sidebar-crate > h2 > a", "lib2")
|
|
assert-count: (".sidebar .location", 0)
|
|
assert-count: (".sidebar h2", 1)
|
|
assert-text: (".sidebar-elems ul.block > li.current > a", "foobar")
|
|
// We check that we don't have the crate list.
|
|
assert-false: ".sidebar-elems > .crate"
|
|
|
|
go-to: "./module/index.html"
|
|
assert-property: (".sidebar", {"clientWidth": "200"})
|
|
assert-text: (".sidebar > .sidebar-crate > h2 > a", "lib2")
|
|
assert-text: (".sidebar .location", "Module module")
|
|
assert-count: (".sidebar .location", 1)
|
|
assert-text: (".sidebar-elems ul.block > li.current > a", "module")
|
|
// Module page requires three headings:
|
|
// - Presistent crate branding (name and version)
|
|
// - Module name, followed by TOC for module headings
|
|
// - "In crate [name]" parent pointer, followed by sibling navigation
|
|
assert-count: (".sidebar h2", 3)
|
|
assert-text: (".sidebar > .sidebar-elems > #rustdoc-modnav > h2", "In crate lib2")
|
|
assert-property: (".sidebar > .sidebar-elems > #rustdoc-modnav > h2 > a", {
|
|
"href": "/lib2/index.html",
|
|
}, ENDS_WITH)
|
|
// We check that we don't have the crate list.
|
|
assert-false: ".sidebar-elems > .crate"
|
|
|
|
go-to: "./sub_module/sub_sub_module/index.html"
|
|
assert-property: (".sidebar", {"clientWidth": "200"})
|
|
assert-text: (".sidebar > .sidebar-crate > h2 > a", "lib2")
|
|
assert-text: (".sidebar .location", "Module sub_sub_module")
|
|
assert-text: (".sidebar > .sidebar-elems > #rustdoc-modnav > h2", "In lib2::module::sub_module")
|
|
assert-property: (".sidebar > .sidebar-elems > #rustdoc-modnav > h2 > a", {
|
|
"href": "/module/sub_module/index.html",
|
|
}, ENDS_WITH)
|
|
assert-text: (".sidebar-elems ul.block > li.current > a", "sub_sub_module")
|
|
// We check that we don't have the crate list.
|
|
assert-false: ".sidebar-elems .crate"
|
|
assert-text: (".sidebar-elems > section ul > li:nth-child(1)", "Functions")
|
|
assert-text: ("#functions + .item-table .item-name > a", "foo")
|
|
|
|
// Links to trait implementations in the sidebar should not wrap even if they are long.
|
|
go-to: "file://" + |DOC_PATH| + "/lib2/struct.HasALongTraitWithParams.html"
|
|
assert-property: (".sidebar", {"clientWidth": "200"})
|
|
assert-property: (".sidebar-elems section .block li > a", {"offsetHeight": 29})
|
|
|
|
// Test that clicking on of the "In <module>" headings in the sidebar links to the
|
|
// appropriate anchor in index.html.
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/struct.Foo.html"
|
|
assert-property: (".sidebar", {"clientWidth": "200"})
|
|
click: "//ul[@class='block mod']/preceding-sibling::h3/a"
|
|
// PAGE: index.html
|
|
assert-css: ("#modules", {"background-color": "#fdffd3"})
|
|
|
|
// Finally, assert that the Summary toggle doesn't affect sidebar width.
|
|
click: "#toggle-all-docs"
|
|
assert-text: ("#toggle-all-docs", "Show all")
|
|
assert-property: (".sidebar", {"clientWidth": "200"})
|
|
click: "#toggle-all-docs"
|
|
assert-text: ("#toggle-all-docs", "Summary")
|
|
assert-property: (".sidebar", {"clientWidth": "200"})
|
|
|
|
// Checks that all.html and index.html have their sidebar link in the same place.
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
|
|
store-property: (".sidebar .sidebar-crate h2 a", {
|
|
"clientWidth": index_sidebar_width,
|
|
"clientHeight": index_sidebar_height,
|
|
"offsetTop": index_sidebar_y,
|
|
"offsetLeft": index_sidebar_x,
|
|
})
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/all.html"
|
|
assert-property: (".sidebar .sidebar-crate h2 a", {
|
|
"clientWidth": |index_sidebar_width|,
|
|
"clientHeight": |index_sidebar_height|,
|
|
"offsetTop": |index_sidebar_y|,
|
|
"offsetLeft": |index_sidebar_x|,
|
|
})
|
|
|
|
// Check that the sidebar links touch the left side of the box
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
|
|
assert-position: (".sidebar .block a", {"x": -4})
|
|
assert-position: (".sidebar-crate > h2 > a", {"x": -3})
|
|
|
|
// Check that the main sidebar links touch the left side of the box
|
|
// but the crate name doesn't, because the logo takes that space
|
|
go-to: "file://" + |DOC_PATH| + "/huge_logo/index.html"
|
|
assert-position: (".sidebar .block a", {"x": -4})
|
|
// when side-by-side, it's not line wrapped
|
|
assert-position-false: (".sidebar-crate > h2 > a", {"x": -3})
|
|
// when line-wrapped, see that it becomes flush-left again
|
|
drag-and-drop: ((205, 100), (108, 100))
|
|
assert-position: (".sidebar-crate > h2 > a", {"x": -3})
|
|
|
|
// Configuration option to show TOC in sidebar.
|
|
set-local-storage: {"rustdoc-hide-toc": "true"}
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/enum.WhoLetTheDogOut.html"
|
|
assert-css: ("#rustdoc-toc", {"display": "none"})
|
|
assert-css: (".sidebar .in-crate", {"display": "none"})
|
|
set-local-storage: {"rustdoc-hide-toc": "false"}
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/enum.WhoLetTheDogOut.html"
|
|
assert-css: ("#rustdoc-toc", {"display": "block"})
|
|
assert-css: (".sidebar .in-crate", {"display": "block"})
|
|
|
|
set-local-storage: {"rustdoc-hide-modnav": "true"}
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/enum.WhoLetTheDogOut.html"
|
|
assert-css: ("#rustdoc-modnav", {"display": "none"})
|
|
set-local-storage: {"rustdoc-hide-modnav": "false"}
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/enum.WhoLetTheDogOut.html"
|
|
assert-css: ("#rustdoc-modnav", {"display": "block"})
|
|
|
|
set-local-storage: {"rustdoc-hide-toc": "true"}
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
|
|
assert-css: ("#rustdoc-toc", {"display": "none"})
|
|
assert-false: ".sidebar .in-crate"
|
|
set-local-storage: {"rustdoc-hide-toc": "false"}
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
|
|
assert-css: ("#rustdoc-toc", {"display": "block"})
|
|
assert-false: ".sidebar .in-crate"
|
|
|
|
set-local-storage: {"rustdoc-hide-modnav": "true"}
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
|
|
assert-css: ("#rustdoc-modnav", {"display": "none"})
|
|
set-local-storage: {"rustdoc-hide-modnav": "false"}
|
|
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
|
|
assert-css: ("#rustdoc-modnav", {"display": "block"})
|