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.

Sign up for GitHub

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

Improve the page title switch handling between search and doc #78921

Merged
merged 1 commit into from
Nov 12, 2020
+5 −2
Merged

Improve the page title switch handling between search and doc #78921

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 5 additions & 2 deletions src/librustdoc/html/static/main.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,7 @@ function defocusSearchBar() {
var mouseMovedAfterSearch = true;

var titleBeforeSearch = document.title;
var searchTitle = null;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we really need another variable? Why not just directly modify document.title?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We do, but it's simpler in case we come back to the search instead of regenerate it once again.


function clearInputTimeout() {
if (searchTimeout !== null) {
Expand Down Expand Up @@ -169,6 +170,7 @@ function defocusSearchBar() {
addClass(main, "hidden");
removeClass(search, "hidden");
mouseMovedAfterSearch = false;
document.title = searchTitle;
}

function hideSearchResults(search) {
Expand All @@ -177,6 +179,7 @@ function defocusSearchBar() {
}
addClass(search, "hidden");
removeClass(main, "hidden");
document.title = titleBeforeSearch;
}

// used for special search precedence
Expand Down Expand Up @@ -374,7 +377,6 @@ function defocusSearchBar() {
clearInputTimeout();
ev.preventDefault();
hideSearchResults(search);
document.title = titleBeforeSearch;
}
defocusSearchBar();
hideThemeButtonState();
Expand Down Expand Up @@ -1782,7 +1784,7 @@ function defocusSearchBar() {
}

// Update document title to maintain a meaningful browser history
document.title = "Results for " + query.query + " - Rust";
searchTitle = "Results for " + query.query + " - Rust";

// Because searching is incremental by character, only the most
// recent search query is added to the browser history.
Expand Down Expand Up @@ -2736,6 +2738,7 @@ function defocusSearchBar() {
"",
"?search=" + encodeURIComponent(search_input.value));
}
document.title = searchTitle;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When does putBackSearch run? Are you sure search() will be run before?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

putBackSearch is run when you focus the search input and it's not empty. Meaning that the search already ran at this point. ;)

}
}

Expand Down