mirror of
https://github.com/rust-lang/rust.git
synced 2024-10-31 22:41:50 +00:00
0a0ea28f26
rustdoc: redesign toolbar and disclosure widgets Fixes #77899 Fixes #90310 ## Preview | before | after | ------ | ----- |  |  |  |  |  |  |  |  |  |  | N/A |  |  |  |  |  https://notriddle.com/rustdoc-html-demo-12/toolbar-v2/std/index.html ## Description 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. CC <https://github.com/rust-lang/rust/pull/113074#issuecomment-1677469680> and ``@jsha`` regarding the use of triangles for disclosure, which is what everyone wanted, but was pending a good toggle-all button. This PR adds a toggle-all button that should work. Settings and Help are also migrated, so that the whole group can benefit from being described using actual words. The breadcrumbs also get redesigned, so that they use less space, by shrinking the parent module path parts. This is done at the same time as the toolbar redesign because it's, effectively, moving space from the toolbar to the breadcrumbs. This is aimed at avoiding any line wrapping at desktop sizes. ## Prior art This style of toolbar, with explicit labels on the buttons, used to be more popular. It's not very common in web browsers nowadays, and for truly universal icons like ⬅️ I can understand why, but words are great when icons fail. 
124 lines
4.1 KiB
Plaintext
124 lines
4.1 KiB
Plaintext
// Check that the line number column has the correct layout.
|
|
go-to: "file://" + |DOC_PATH| + "/scrape_examples/fn.test_many.html"
|
|
|
|
set-window-size: (1000, 1000)
|
|
|
|
// Check that it's not zero.
|
|
assert-property-false: (
|
|
".more-scraped-examples .scraped-example .src-line-numbers",
|
|
{"clientWidth": "0"}
|
|
)
|
|
|
|
// Check that examples with very long lines have the same width as ones that don't.
|
|
store-property: (
|
|
".more-scraped-examples .scraped-example:nth-child(2) .src-line-numbers",
|
|
{"clientWidth": clientWidth},
|
|
)
|
|
|
|
assert-property: (
|
|
".more-scraped-examples .scraped-example:nth-child(3) .src-line-numbers",
|
|
{"clientWidth": |clientWidth|}
|
|
)
|
|
|
|
assert-property: (
|
|
".more-scraped-examples .scraped-example:nth-child(4) .src-line-numbers",
|
|
{"clientWidth": |clientWidth|}
|
|
)
|
|
|
|
assert-property: (
|
|
".more-scraped-examples .scraped-example:nth-child(5) .src-line-numbers",
|
|
{"clientWidth": |clientWidth|}
|
|
)
|
|
|
|
assert-property: (
|
|
".more-scraped-examples .scraped-example:nth-child(6) .src-line-numbers",
|
|
{"clientWidth": |clientWidth|}
|
|
)
|
|
|
|
// The "title" should be located at the right bottom corner of the code example.
|
|
store-position: (".scraped-example .example-wrap", {"x": x, "y": y})
|
|
assert-size: (".scraped-example .example-wrap", {"height": 130})
|
|
store-size: (".scraped-example .example-wrap", {"width": width, "height": height})
|
|
store-size: (".scraped-example .scraped-example-title", {
|
|
"width": title_width,
|
|
"height": title_height,
|
|
})
|
|
assert-position: (".scraped-example .scraped-example-title", {
|
|
"x": |x| + |width| - |title_width| - 5,
|
|
"y": |y| + |height| - |title_height| - 8,
|
|
})
|
|
|
|
store-size: (".more-scraped-examples .scraped-example .example-wrap", {"height": more_height})
|
|
assert: |more_height| > |height|
|
|
assert-size: (".more-scraped-examples .scraped-example .example-wrap", {
|
|
"height": 250,
|
|
"width": |width|,
|
|
})
|
|
|
|
// Check that the expand button works and also that line number aligns with code.
|
|
move-cursor-to: ".scraped-example .rust"
|
|
click: ".scraped-example .button-holder .expand"
|
|
wait-for: ".scraped-example.expanded"
|
|
// They should have the same y position.
|
|
compare-elements-position: (
|
|
".scraped-example.expanded .src-line-numbers pre span",
|
|
".scraped-example.expanded .rust code",
|
|
["y"],
|
|
)
|
|
// And they should have the same height.
|
|
compare-elements-size: (
|
|
".scraped-example.expanded .src-line-numbers",
|
|
".scraped-example.expanded .rust",
|
|
["height"],
|
|
)
|
|
// Collapse code again.
|
|
click: ".scraped-example .button-holder .expand"
|
|
|
|
// Check that for both mobile and desktop sizes, the buttons in scraped examples are displayed
|
|
// correctly.
|
|
|
|
store-value: (offset_y, 4)
|
|
|
|
// First with desktop
|
|
assert-position: (".scraped-example", {"y": 252})
|
|
assert-position: (".scraped-example .prev", {"y": 252 + |offset_y|})
|
|
|
|
// Gradient background should be at the top of the code block.
|
|
assert-css: (".scraped-example .example-wrap::before", {"top": "0px"})
|
|
assert-css: (".scraped-example .example-wrap::after", {"bottom": "0px"})
|
|
|
|
// Then with mobile
|
|
set-window-size: (600, 600)
|
|
store-size: (".scraped-example .scraped-example-title", {"height": title_height})
|
|
assert-position: (".scraped-example", {"y": 281})
|
|
assert-position: (".scraped-example .prev", {"y": 281 + |offset_y| + |title_height|})
|
|
|
|
define-function: (
|
|
"check_title_and_code_position",
|
|
[],
|
|
block {
|
|
// Title should be above the code.
|
|
store-position: (".scraped-example .example-wrap .src-line-numbers", {"x": x, "y": y})
|
|
store-size: (".scraped-example .scraped-example-title", { "height": title_height })
|
|
|
|
assert-position: (".scraped-example .scraped-example-title", {
|
|
"x": |x|, // same X position.
|
|
"y": |y| - |title_height|,
|
|
})
|
|
|
|
// Line numbers should be right beside the code.
|
|
compare-elements-position: (
|
|
".scraped-example .example-wrap .src-line-numbers",
|
|
".scraped-example .example-wrap .rust",
|
|
["y"],
|
|
)
|
|
}
|
|
)
|
|
|
|
// Check that the title is now above the code.
|
|
call-function: ("check_title_and_code_position", {})
|
|
|
|
// Then with small mobile
|
|
set-window-size: (300, 300)
|
|
call-function: ("check_title_and_code_position", {})
|