Skip to content

Commit a6bc517

Browse files
rust-timerrust-timer
authored
Unrolled build for rust-lang#128394
Rollup merge of rust-lang#128394 - GuillaumeGomez:run-button, r=t-rustdoc Unify run button display with "copy code" button and with mdbook buttons Follow-up of rust-lang#128339. It looks like this (coherency++, yeay!): ![Screenshot from 2024-07-30 15-16-31](https://github.com/user-attachments/assets/5e262e5b-f338-4085-94ca-e223033a43db) Can be tested [here](https://rustdoc.crud.net/imperio/run-button/foo/struct.Bar.html). r? `@notriddle`
2 parents e08b80c + 59cb159 commit a6bc517

10 files changed

+111
-105
lines changed

‎src/librustdoc/html/markdown.rs

+2-1
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,8 @@ impl<'a, I: Iterator<Item = Event<'a>>> Iterator for CodeBlocks<'_, 'a, I> {
304304
Some(format!(
305305
"<a class=\"test-arrow\" \
306306
target=\"_blank\" \
307-
href=\"{url}?code={test_escaped}{channel}&amp;edition={edition}\">Run</a>",
307+
title=\"Run code\" \
308+
href=\"{url}?code={test_escaped}{channel}&amp;edition={edition}\"></a>",
308309
))
309310
});
310311

‎src/librustdoc/html/static/css/noscript.css

-8
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,6 @@ nav.sub {
104104
--code-highlight-doc-comment-color: #4d4d4c;
105105
--src-line-numbers-span-color: #c67e2d;
106106
--src-line-number-highlighted-background-color: #fdffd3;
107-
--test-arrow-color: #f5f5f5;
108-
--test-arrow-background-color: rgba(78, 139, 202, 0.2);
109-
--test-arrow-hover-color: #f5f5f5;
110-
--test-arrow-hover-background-color: rgb(78, 139, 202);
111107
--target-background-color: #fdffd3;
112108
--target-border-color: #ad7c37;
113109
--kbd-color: #000;
@@ -210,10 +206,6 @@ nav.sub {
210206
--code-highlight-doc-comment-color: #8ca375;
211207
--src-line-numbers-span-color: #3b91e2;
212208
--src-line-number-highlighted-background-color: #0a042f;
213-
--test-arrow-color: #dedede;
214-
--test-arrow-background-color: rgba(78, 139, 202, 0.2);
215-
--test-arrow-hover-color: #dedede;
216-
--test-arrow-hover-background-color: #4e8bca;
217209
--target-background-color: #494a3d;
218210
--target-border-color: #bb7410;
219211
--kbd-color: #000;

‎src/librustdoc/html/static/css/rustdoc.css

+21-33
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ details:not(.toggle) summary {
353353
margin-bottom: .6em;
354354
}
355355

356-
code, pre, a.test-arrow, .code-header {
356+
code, pre, .code-header {
357357
font-family: "Source Code Pro", monospace;
358358
}
359359
.docblock code, .docblock-short code {
@@ -946,8 +946,8 @@ because of the `[-]` element which would overlap with it. */
946946
.main-heading a:hover,
947947
.example-wrap .rust a:hover,
948948
.all-items a:hover,
949-
.docblock a:not(.test-arrow):not(.scrape-help):not(.tooltip):hover:not(.doc-anchor),
950-
.docblock-short a:not(.test-arrow):not(.scrape-help):not(.tooltip):hover,
949+
.docblock a:not(.scrape-help):not(.tooltip):hover:not(.doc-anchor),
950+
.docblock-short a:not(.scrape-help):not(.tooltip):hover,
951951
.item-info a {
952952
text-decoration: underline;
953953
}
@@ -1461,22 +1461,17 @@ documentation. */
14611461
z-index: 1;
14621462
}
14631463
a.test-arrow {
1464-
padding: 5px 7px;
1465-
border-radius: var(--button-border-radius);
1466-
font-size: 1rem;
1467-
color: var(--test-arrow-color);
1468-
background-color: var(--test-arrow-background-color);
1464+
height: var(--copy-path-height);
1465+
padding: 6px 4px 0 11px;
14691466
}
1470-
a.test-arrow:hover {
1471-
color: var(--test-arrow-hover-color);
1472-
background-color: var(--test-arrow-hover-background-color);
1467+
a.test-arrow::before {
1468+
content: url('data:image/svg+xml,<svg viewBox="0 0 20 20" width="18" height="20" \
1469+
xmlns="http://www.w3.org/2000/svg"><path d="M0 0l18 10-18 10z"/></svg>');
14731470
}
14741471
.example-wrap .button-holder {
14751472
display: flex;
14761473
}
1477-
.example-wrap:hover > .test-arrow {
1478-
padding: 2px 7px;
1479-
}
1474+
14801475
/*
14811476
On iPad, the ":hover" state sticks around, making things work not greatly. Do work around
14821477
it, we move it into this media query. More information can be found at:
@@ -1486,29 +1481,34 @@ However, using `@media (hover: hover)` makes this rule never to be applied in GU
14861481
instead, we check that it's not a "finger" cursor.
14871482
*/
14881483
@media not (pointer: coarse) {
1489-
.example-wrap:hover > .test-arrow, .example-wrap:hover > .button-holder {
1484+
.example-wrap:hover > a.test-arrow, .example-wrap:hover > .button-holder {
14901485
visibility: visible;
14911486
}
14921487
}
14931488
.example-wrap .button-holder.keep-visible {
14941489
visibility: visible;
14951490
}
1496-
.example-wrap .button-holder .copy-button {
1497-
color: var(--copy-path-button-color);
1491+
.example-wrap .button-holder .copy-button, .example-wrap .test-arrow {
14981492
background: var(--main-background-color);
1493+
cursor: pointer;
1494+
border-radius: var(--button-border-radius);
14991495
height: var(--copy-path-height);
15001496
width: var(--copy-path-width);
1497+
}
1498+
.example-wrap .button-holder .copy-button {
15011499
margin-left: var(--button-left-margin);
15021500
padding: 2px 0 0 4px;
15031501
border: 0;
1504-
cursor: pointer;
1505-
border-radius: var(--button-border-radius);
15061502
}
1507-
.example-wrap .button-holder .copy-button::before {
1503+
.example-wrap .button-holder .copy-button::before,
1504+
.example-wrap .test-arrow::before {
15081505
filter: var(--copy-path-img-filter);
1506+
}
1507+
.example-wrap .button-holder .copy-button::before {
15091508
content: var(--clipboard-image);
15101509
}
1511-
.example-wrap .button-holder .copy-button:hover::before {
1510+
.example-wrap .button-holder .copy-button:hover::before,
1511+
.example-wrap .test-arrow:hover::before {
15121512
filter: var(--copy-path-img-hover-filter);
15131513
}
15141514
.example-wrap .button-holder .copy-button.clicked::before {
@@ -2552,10 +2552,6 @@ by default.
25522552
--code-highlight-doc-comment-color: #4d4d4c;
25532553
--src-line-numbers-span-color: #c67e2d;
25542554
--src-line-number-highlighted-background-color: #fdffd3;
2555-
--test-arrow-color: #f5f5f5;
2556-
--test-arrow-background-color: rgba(78, 139, 202, 0.2);
2557-
--test-arrow-hover-color: #f5f5f5;
2558-
--test-arrow-hover-background-color: rgb(78, 139, 202);
25592555
--target-background-color: #fdffd3;
25602556
--target-border-color: #ad7c37;
25612557
--kbd-color: #000;
@@ -2658,10 +2654,6 @@ by default.
26582654
--code-highlight-doc-comment-color: #8ca375;
26592655
--src-line-numbers-span-color: #3b91e2;
26602656
--src-line-number-highlighted-background-color: #0a042f;
2661-
--test-arrow-color: #dedede;
2662-
--test-arrow-background-color: rgba(78, 139, 202, 0.2);
2663-
--test-arrow-hover-color: #dedede;
2664-
--test-arrow-hover-background-color: #4e8bca;
26652657
--target-background-color: #494a3d;
26662658
--target-border-color: #bb7410;
26672659
--kbd-color: #000;
@@ -2771,10 +2763,6 @@ Original by Dempfi (https://github.com/dempfi/ayu)
27712763
--code-highlight-doc-comment-color: #a1ac88;
27722764
--src-line-numbers-span-color: #5c6773;
27732765
--src-line-number-highlighted-background-color: rgba(255, 236, 164, 0.06);
2774-
--test-arrow-color: #788797;
2775-
--test-arrow-background-color: rgba(57, 175, 215, 0.09);
2776-
--test-arrow-hover-color: #c5c5c5;
2777-
--test-arrow-hover-background-color: rgba(57, 175, 215, 0.368);
27782766
--target-background-color: rgba(255, 236, 164, 0.06);
27792767
--target-border-color: rgba(255, 180, 76, 0.85);
27802768
--kbd-color: #c5c5c5;

‎src/librustdoc/html/static/js/main.js

+6-2
Original file line numberDiff line numberDiff line change
@@ -1835,10 +1835,14 @@ href="https://doc.rust-lang.org/${channel}/rustdoc/read-documentation/search.htm
18351835
function getExampleWrap(event) {
18361836
let elem = event.target;
18371837
while (!hasClass(elem, "example-wrap")) {
1838-
elem = elem.parentElement;
1839-
if (elem === document.body || hasClass(elem, "docblock")) {
1838+
if (elem === document.body ||
1839+
elem.tagName === "A" ||
1840+
elem.tagName === "BUTTON" ||
1841+
hasClass(elem, "docblock")
1842+
) {
18401843
return null;
18411844
}
1845+
elem = elem.parentElement;
18421846
}
18431847
return elem;
18441848
}

‎tests/rustdoc-gui/code-example-buttons.goml

+75
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
// This test ensures that code blocks buttons are displayed on hover and when you click on them.
22
go-to: "file://" + |DOC_PATH| + "/test_docs/fn.foo.html"
3+
include: "utils.goml"
34

45
// First we check we "hover".
56
move-cursor-to: ".example-wrap"
@@ -19,3 +20,77 @@ click: ".example-wrap"
1920
move-cursor-to: ".search-input"
2021
assert-count: (".example-wrap:not(:hover) .button-holder.keep-visible", 0)
2122
assert-css: (".example-wrap .copy-button", { "visibility": "hidden" })
23+
24+
// Clicking on the "copy code" button shouldn't make the buttons stick.
25+
click: ".example-wrap .copy-button"
26+
move-cursor-to: ".search-input"
27+
assert-count: (".example-wrap:not(:hover) .button-holder.keep-visible", 0)
28+
assert-css: (".example-wrap .copy-button", { "visibility": "hidden" })
29+
30+
define-function: (
31+
"check-buttons",
32+
[theme, background, filter, filter_hover],
33+
block {
34+
call-function: ("switch-theme", {"theme": |theme|})
35+
36+
assert-css: (".example-wrap .test-arrow", {"visibility": "hidden"})
37+
assert-css: (".example-wrap .copy-button", {"visibility": "hidden"})
38+
39+
move-cursor-to: ".example-wrap"
40+
assert-css: (".example-wrap .test-arrow", {
41+
"visibility": "visible",
42+
"background-color": |background|,
43+
"border-radius": "2px",
44+
})
45+
assert-css: (".example-wrap .test-arrow::before", {
46+
"filter": |filter|,
47+
})
48+
assert-css: (".example-wrap .copy-button", {
49+
"visibility": "visible",
50+
"background-color": |background|,
51+
"border-radius": "2px",
52+
})
53+
assert-css: (".example-wrap .copy-button::before", {
54+
"filter": |filter|,
55+
})
56+
57+
move-cursor-to: ".example-wrap .test-arrow"
58+
assert-css: (".example-wrap .test-arrow:hover", {
59+
"visibility": "visible",
60+
"background-color": |background|,
61+
"border-radius": "2px",
62+
})
63+
assert-css: (".example-wrap .test-arrow:hover::before", {
64+
"filter": |filter_hover|,
65+
})
66+
67+
move-cursor-to: ".example-wrap .copy-button"
68+
assert-css: (".example-wrap .copy-button:hover", {
69+
"visibility": "visible",
70+
"background-color": |background|,
71+
"border-radius": "2px",
72+
})
73+
assert-css: (".example-wrap .copy-button:hover::before", {
74+
"filter": |filter_hover|,
75+
})
76+
},
77+
)
78+
79+
call-function: ("check-buttons",{
80+
"theme": "ayu",
81+
"background": "#0f1419",
82+
"filter": "invert(0.7)",
83+
"filter_hover": "invert(1)",
84+
})
85+
call-function: ("check-buttons",{
86+
"theme": "dark",
87+
"background": "#353535",
88+
"filter": "invert(0.5)",
89+
"filter_hover": "invert(0.65)",
90+
})
91+
call-function: ("check-buttons",{
92+
"theme": "light",
93+
"background": "#fff",
94+
"filter": "invert(0.5)",
95+
"filter_hover": "invert(0.35)",
96+
})

‎tests/rustdoc-gui/copy-code.goml

+2-2
Original file line numberDiff line numberDiff line change
@@ -24,11 +24,11 @@ define-function: (
2424
)
2525

2626
call-function: ("check-copy-button", {})
27-
// Checking that the run button and the copy button have the same height.
27+
// Checking that the run button and the copy button have the same height and same width.
2828
compare-elements-size: (
2929
".example-wrap:nth-of-type(1) .test-arrow",
3030
".example-wrap:nth-of-type(1) .copy-button",
31-
["height"],
31+
["height", "width"],
3232
)
3333
// ... and the same y position.
3434
compare-elements-position: (

‎tests/rustdoc-gui/run-on-hover.goml

-54
This file was deleted.

‎tests/rustdoc/playground-arg.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@
1010
pub fn dummy() {}
1111

1212
// ensure that `extern crate foo;` was inserted into code snips automatically:
13-
//@ matches foo/index.html '//a[@class="test-arrow"][@href="https://example.com/?code=%23!%5Ballow(unused)%5D%0A%23%5Ballow(unused_extern_crates)%5D%0Aextern+crate+r%23foo;%0Afn+main()+%7B%0A++++use+foo::dummy;%0A++++dummy();%0A%7D&edition=2015"]' "Run"
13+
//@ matches foo/index.html '//a[@class="test-arrow"][@href="https://example.com/?code=%23!%5Ballow(unused)%5D%0A%23%5Ballow(unused_extern_crates)%5D%0Aextern+crate+r%23foo;%0Afn+main()+%7B%0A++++use+foo::dummy;%0A++++dummy();%0A%7D&edition=2015"]' ""

‎tests/rustdoc/playground-syntax-error.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,5 +17,5 @@
1717
pub fn bar() {}
1818

1919
//@ has foo/fn.bar.html
20-
//@ has - '//a[@class="test-arrow"]' "Run"
20+
//@ has - '//a[@class="test-arrow"]' ""
2121
//@ has - '//*[@class="docblock"]' 'foo_recursive'

‎tests/rustdoc/playground.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,6 @@
2222
//! }
2323
//! ```
2424
25-
//@ matches foo/index.html '//a[@class="test-arrow"][@href="https://www.example.com/?code=%23!%5Ballow(unused)%5D%0Afn+main()+%7B%0A++++println!(%22Hello,+world!%22);%0A%7D&edition=2015"]' "Run"
26-
//@ matches foo/index.html '//a[@class="test-arrow"][@href="https://www.example.com/?code=%23!%5Ballow(unused)%5D%0Afn+main()+%7B%0A++++println!(%22Hello,+world!%22);%0A%7D&edition=2015"]' "Run"
27-
//@ matches foo/index.html '//a[@class="test-arrow"][@href="https://www.example.com/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(something)%5D%0A%0Afn+main()+%7B%0A++++println!(%22Hello,+world!%22);%0A%7D&version=nightly&edition=2015"]' "Run"
25+
//@ matches foo/index.html '//a[@class="test-arrow"][@href="https://www.example.com/?code=%23!%5Ballow(unused)%5D%0Afn+main()+%7B%0A++++println!(%22Hello,+world!%22);%0A%7D&edition=2015"]' ""
26+
//@ matches foo/index.html '//a[@class="test-arrow"][@href="https://www.example.com/?code=%23!%5Ballow(unused)%5D%0Afn+main()+%7B%0A++++println!(%22Hello,+world!%22);%0A%7D&edition=2015"]' ""
27+
//@ matches foo/index.html '//a[@class="test-arrow"][@href="https://www.example.com/?code=%23!%5Ballow(unused)%5D%0A%23!%5Bfeature(something)%5D%0A%0Afn+main()+%7B%0A++++println!(%22Hello,+world!%22);%0A%7D&version=nightly&edition=2015"]' ""

0 commit comments

Comments
 (0)