Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix source code sidebar tree auto-expand #99373

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/librustdoc/html/static/js/source-script.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ function createDirEntry(elem, parent, fullPath, hasFoundFile) {
folders.className = "folders";
if (elem.dirs) {
for (const dir of elem.dirs) {
if (createDirEntry(dir, folders, fullPath, hasFoundFile)) {
if (createDirEntry(dir, folders, fullPath, false)) {
GuillaumeGomez marked this conversation as resolved.
Show resolved Hide resolved
dirEntry.open = true;
hasFoundFile = true;
}
Expand Down
22 changes: 17 additions & 5 deletions src/test/rustdoc-gui/sidebar-source-code.goml
Original file line number Diff line number Diff line change
Expand Up @@ -16,15 +16,27 @@ click: (10, 10)
wait-for: "html:not(.expanded)"
assert: "nav.sidebar"

// Checking that only the path to the current file is "open".
goto: file://|DOC_PATH|/src/lib2/another_folder/sub_mod/mod.rs.html
// First we expand the sidebar again.
click: (10, 10)
// We wait for the sidebar to be expanded.
wait-for-css: (".source-sidebar-expanded nav.sidebar", {"width": "300px"})
assert: "//*[@class='dir-entry' and @open]/*[text()='lib2']"
assert: "//*[@class='dir-entry' and @open]/*[text()='another_folder']"
assert: "//*[@class='dir-entry' and @open]/*[text()='sub_mod']"
// Only "another_folder" should be "open" in "lib2".
assert: "//*[@class='dir-entry' and not(@open)]/*[text()='another_mod']"
// All other trees should be collapsed.
assert-count: ("//*[@id='source-sidebar']/details[not(text()='lib2') and not(@open)]", 5)

// We now switch to mobile mode.
size: (600, 600)
// We check that the sidebar has the expected width (0).
assert-css: ("nav.sidebar", {"width": "0px"})
// We expand the sidebar.
click: "#sidebar-toggle"
assert-css: (".source-sidebar-expanded nav.sidebar", {"width": "600px"})
wait-for-css: (".source-sidebar-expanded nav.sidebar", {"width": "600px"})
// We collapse the sidebar.
click: (10, 10)
// We check that the sidebar has the expected width (0).
assert-css: ("nav.sidebar", {"width": "0px"})
// We ensure that the class has been removed.
assert-false: ".source-sidebar-expanded"
assert: "nav.sidebar"
Expand Down
3 changes: 3 additions & 0 deletions src/test/rustdoc-gui/src/lib2/another_folder/mod.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
pub fn another_fn() {}

pub mod sub_mod;
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pub fn subsubsub() {}
1 change: 1 addition & 0 deletions src/test/rustdoc-gui/src/lib2/another_mod/mod.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pub fn tadam() {}
3 changes: 3 additions & 0 deletions src/test/rustdoc-gui/src/lib2/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@

#![feature(doc_cfg)]

pub mod another_folder;
pub mod another_mod;

pub mod module {
pub mod sub_module {
pub mod sub_sub_module {
Expand Down