bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Auto merge of #62941 - GuillaumeGomez:save-crate-filter, r=Mark-Simulacrum

Browse source 
Save crate filtering on rustdoc

Fixes #62929.

I added a hashmap and a hash encoding for the current crate list in case you have multiple crates handling on a same website (who talked about docs.rs?!). Like that, for each context, you have the filter crate selected.

r? @QuietMisdreavus
This commit is contained in:
bors 2019-08-28 21:42:52 +00:00
commit 0414dfa0aa
2 changed files with 19 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

20
src/librustdoc/html/static/main.js
View file

@ -445,6 +445,21 @@ if (!DOMTokenList.prototype.remove) {
var OUTPUT_DATA = 1; var OUTPUT_DATA = 1;
var params = getQueryStringParams(); var params = getQueryStringParams();
// Set the crate filter from saved storage, if the current page has the saved crate filter.
//
// If not, ignore the crate filter -- we want to support filtering for crates on sites like
// doc.rust-lang.org where the crates may differ from page to page while on the same domain.
var savedCrate = getCurrentValue("rustdoc-saved-filter-crate");
if (savedCrate !== null) {
onEachLazy(document.getElementById("crate-search").getElementsByTagName("option"),
function(e) {
if (e.value === savedCrate) {
document.getElementById("crate-search").value = e.value;
return true;
}
});
}
// Populate search bar with query string search term when provided, // Populate search bar with query string search term when provided,
// but only if the input bar is empty. This avoid the obnoxious issue // but only if the input bar is empty. This avoid the obnoxious issue
// where you start trying to do a search, and the index loads, and // where you start trying to do a search, and the index loads, and
@ -1658,9 +1673,10 @@ if (!DOMTokenList.prototype.remove) {
}; };
search_input.onpaste = search_input.onchange; search_input.onpaste = search_input.onchange;
var selectCrate = document.getElementById('crate-search'); var selectCrate = document.getElementById("crate-search");
if (selectCrate) { if (selectCrate) {
selectCrate.onchange = function() { selectCrate.onchange = function() {
updateLocalStorage("rustdoc-saved-filter-crate", selectCrate.value);
search(undefined, true); search(undefined, true);
}; };
} }
@ -2496,7 +2512,7 @@ if (!DOMTokenList.prototype.remove) {
} }
function addSearchOptions(crates) { function addSearchOptions(crates) {
var elem = document.getElementById('crate-search'); var elem = document.getElementById("crate-search");
if (!elem) { if (!elem) {
return; return;

2
src/librustdoc/html/static/storage.js
View file

@ -57,7 +57,7 @@ function onEachLazy(lazyArray, func, reversed) {
function usableLocalStorage() { function usableLocalStorage() {
// Check if the browser supports localStorage at all: // Check if the browser supports localStorage at all:
if (typeof(Storage) === "undefined") { if (typeof Storage === "undefined") {
return false; return false;
} }
// Check if we can access it; this access will fail if the browser // Check if we can access it; this access will fail if the browser