Mirrors/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2026-04-27 18:57:42 +03:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #155395 - GuillaumeGomez:copy-path-with-ronga, r=notriddle

Browse Source 
Tweak how the "copy path" rustdoc button works to allow some accessibility tool to work with rustdoc

Fixes https://github.com/rust-lang/rust/issues/155032.

It's a bit better in term of "fragility" to retrieve this information: no need to parse text anymore, just to retrieve content. However it relies on HTML. I added extra tests to ensure it won't break without notice.

cc @Enyium

r? @lolbinarycat
This commit is contained in:
Stuart Cook
2026-04-17 16:18:00 +10:00
committed by GitHub
parent 7e43cdf977 6c4ec59d5f
commit f92c79e3e0
2 changed files with 36 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/librustdoc/html/static/js/main.js
+20 -13
View File
@@ -2123,20 +2123,27 @@ function preLoadCss(cssUrl) {
return;
}
but.onclick = () => {
// Most page titles are '<Item> in <path::to::module> - Rust', except
// modules (which don't have the first part) and keywords/primitives
// (which don't have a module path)
const titleElement = document.querySelector("title");
const title = titleElement && titleElement.textContent ?
titleElement.textContent.replace(" - Rust", "") : "";
const [item, module] = title.split(" in ");
const path = [item];
if (module !== undefined) {
path.unshift(module);
}
// We get the path from the "breadcrumbs" and the actual item name.
let path = "";
// @ts-expect-error
const heading = document.getElementById(MAIN_ID).querySelector(".main-heading");
copyContentToClipboard(path.join("::"));
copyButtonAnimation(but);
if (heading) {
const breadcrumbs = heading.querySelector(".rustdoc-breadcrumbs");
if (breadcrumbs) {
// @ts-expect-error
path = breadcrumbs.innerText;
if (path.length > 0) {
path += "::";
}
}
// @ts-expect-error
path += heading.querySelector("h1 > span").innerText;
copyContentToClipboard(path);
copyButtonAnimation(but);
}
};
/**
tests/rustdoc-gui/copy-path.goml
+16
View File
@@ -18,3 +18,19 @@ assert-size: ("#copy-path.clicked", {"width": |width|, "height": |height|})
wait-for: "#copy-path:not(.clicked)"
// We check that the size is still the same.
assert-size: ("#copy-path:not(.clicked)", {"width": |width|, "height": |height|})
// Check the path for a module.
go-to: "file://" + |DOC_PATH| + "/test_docs/foreign_impl_order/index.html"
click: "#copy-path"
// We wait for the new text to appear.
wait-for: "#copy-path.clicked"
// We check that the clipboard value is the expected one.
assert-clipboard: "test_docs::foreign_impl_order"
// Check the path for the crate.
go-to: "file://" + |DOC_PATH| + "/test_docs/index.html"
click: "#copy-path"
// We wait for the new text to appear.
wait-for: "#copy-path.clicked"
// We check that the clipboard value is the expected one.
assert-clipboard: "test_docs"