src/librustdoc/html/static/js/storage.js

   1 // storage.js is loaded in the `<head>` of all rustdoc pages and doesn't
   2 // use `async` or `defer`. That means it blocks further parsing and rendering
   3 // of the page: https://developer.mozilla.org/en-US/docs/Web/HTML/Element/script.
   4 // This makes it the correct place to act on settings that affect the display of
   5 // the page, so we don't see major layout changes during the load of the page.
   6 "use strict";
   7
   8 const darkThemes = ["dark", "ayu"];
   9 window.currentTheme = document.getElementById("themeStyle");
  10 window.mainTheme = document.getElementById("mainThemeStyle");
  11
  12 // WARNING: RUSTDOC_MOBILE_BREAKPOINT MEDIA QUERY
  13 // If you update this line, then you also need to update the media query with the same
  14 // warning in rustdoc.css
  15 window.RUSTDOC_MOBILE_BREAKPOINT = 700;
  16
  17 const settingsDataset = (function() {
  18     const settingsElement = document.getElementById("default-settings");
  19     if (settingsElement === null) {
  20         return null;
  21     }
  22     const dataset = settingsElement.dataset;
  23     if (dataset === undefined) {
  24         return null;
  25     }
  26     return dataset;
  27 })();
  28
  29 function getSettingValue(settingName) {
  30     const current = getCurrentValue(settingName);
  31     if (current !== null) {
  32         return current;
  33     }
  34     if (settingsDataset !== null) {
  35         // See the comment for `default_settings.into_iter()` etc. in
  36         // `Options::from_matches` in `librustdoc/config.rs`.
  37         const def = settingsDataset[settingName.replace(/-/g,"_")];
  38         if (def !== undefined) {
  39             return def;
  40         }
  41     }
  42     return null;
  43 }
  44
  45 const localStoredTheme = getSettingValue("theme");
  46
  47 const savedHref = [];
  48
  49 // eslint-disable-next-line no-unused-vars
  50 function hasClass(elem, className) {
  51     return elem && elem.classList && elem.classList.contains(className);
  52 }
  53
  54 // eslint-disable-next-line no-unused-vars
  55 function addClass(elem, className) {
  56     if (!elem || !elem.classList) {
  57         return;
  58     }
  59     elem.classList.add(className);
  60 }
  61
  62 // eslint-disable-next-line no-unused-vars
  63 function removeClass(elem, className) {
  64     if (!elem || !elem.classList) {
  65         return;
  66     }
  67     elem.classList.remove(className);
  68 }
  69
  70 /**
  71  * Run a callback for every element of an Array.
  72  * @param {Array<?>}    arr        - The array to iterate over
  73  * @param {function(?)} func       - The callback
  74  * @param {boolean}     [reversed] - Whether to iterate in reverse
  75  */
  76 function onEach(arr, func, reversed) {
  77     if (arr && arr.length > 0 && func) {
  78         if (reversed) {
  79             const length = arr.length;
  80             for (let i = length - 1; i >= 0; --i) {
  81                 if (func(arr[i])) {
  82                     return true;
  83                 }
  84             }
  85         } else {
  86             for (const elem of arr) {
  87                 if (func(elem)) {
  88                     return true;
  89                 }
  90             }
  91         }
  92     }
  93     return false;
  94 }
  95
  96 /**
  97  * Turn an HTMLCollection or a NodeList into an Array, then run a callback
  98  * for every element. This is useful because iterating over an HTMLCollection
  99  * or a "live" NodeList while modifying it can be very slow.
 100  * https://developer.mozilla.org/en-US/docs/Web/API/HTMLCollection
 101  * https://developer.mozilla.org/en-US/docs/Web/API/NodeList
 102  * @param {NodeList<?>|HTMLCollection<?>} lazyArray  - An array to iterate over
 103  * @param {function(?)}                   func       - The callback
 104  * @param {boolean}                       [reversed] - Whether to iterate in reverse
 105  */
 106 function onEachLazy(lazyArray, func, reversed) {
 107     return onEach(
 108         Array.prototype.slice.call(lazyArray),
 109         func,
 110         reversed);
 111 }
 112
 113 function updateLocalStorage(name, value) {
 114     try {
 115         window.localStorage.setItem("rustdoc-" + name, value);
 116     } catch (e) {
 117         // localStorage is not accessible, do nothing
 118     }
 119 }
 120
 121 function getCurrentValue(name) {
 122     try {
 123         return window.localStorage.getItem("rustdoc-" + name);
 124     } catch (e) {
 125         return null;
 126     }
 127 }
 128
 129 function switchTheme(styleElem, mainStyleElem, newTheme, saveTheme) {
 130     const newHref = mainStyleElem.href.replace(
 131         /\/rustdoc([^/]*)\.css/, "/" + newTheme + "$1" + ".css");
 132
 133     // If this new value comes from a system setting or from the previously
 134     // saved theme, no need to save it.
 135     if (saveTheme) {
 136         updateLocalStorage("theme", newTheme);
 137     }
 138
 139     if (styleElem.href === newHref) {
 140         return;
 141     }
 142
 143     let found = false;
 144     if (savedHref.length === 0) {
 145         onEachLazy(document.getElementsByTagName("link"), el => {
 146             savedHref.push(el.href);
 147         });
 148     }
 149     onEach(savedHref, el => {
 150         if (el === newHref) {
 151             found = true;
 152             return true;
 153         }
 154     });
 155     if (found) {
 156         styleElem.href = newHref;
 157     }
 158 }
 159
 160 // This function is called from "main.js".
 161 // eslint-disable-next-line no-unused-vars
 162 function useSystemTheme(value) {
 163     if (value === undefined) {
 164         value = true;
 165     }
 166
 167     updateLocalStorage("use-system-theme", value);
 168
 169     // update the toggle if we're on the settings page
 170     const toggle = document.getElementById("use-system-theme");
 171     if (toggle && toggle instanceof HTMLInputElement) {
 172         toggle.checked = value;
 173     }
 174 }
 175
 176 const updateSystemTheme = (function() {
 177     if (!window.matchMedia) {
 178         // fallback to the CSS computed value
 179         return () => {
 180             const cssTheme = getComputedStyle(document.documentElement)
 181                 .getPropertyValue("content");
 182
 183             switchTheme(
 184                 window.currentTheme,
 185                 window.mainTheme,
 186                 JSON.parse(cssTheme) || "light",
 187                 true
 188             );
 189         };
 190     }
 191
 192     // only listen to (prefers-color-scheme: dark) because light is the default
 193     const mql = window.matchMedia("(prefers-color-scheme: dark)");
 194
 195     function handlePreferenceChange(mql) {
 196         const use = theme => {
 197             switchTheme(window.currentTheme, window.mainTheme, theme, true);
 198         };
 199         // maybe the user has disabled the setting in the meantime!
 200         if (getSettingValue("use-system-theme") !== "false") {
 201             const lightTheme = getSettingValue("preferred-light-theme") || "light";
 202             const darkTheme = getSettingValue("preferred-dark-theme") || "dark";
 203
 204             if (mql.matches) {
 205                 use(darkTheme);
 206             } else {
 207                 // prefers a light theme, or has no preference
 208                 use(lightTheme);
 209             }
 210             // note: we save the theme so that it doesn't suddenly change when
 211             // the user disables "use-system-theme" and reloads the page or
 212             // navigates to another page
 213         } else {
 214             use(getSettingValue("theme"));
 215         }
 216     }
 217
 218     mql.addListener(handlePreferenceChange);
 219
 220     return () => {
 221         handlePreferenceChange(mql);
 222     };
 223 })();
 224
 225 function switchToSavedTheme() {
 226     switchTheme(
 227         window.currentTheme,
 228         window.mainTheme,
 229         getSettingValue("theme") || "light",
 230         false
 231     );
 232 }
 233
 234 if (getSettingValue("use-system-theme") !== "false" && window.matchMedia) {
 235     // update the preferred dark theme if the user is already using a dark theme
 236     // See https://github.com/rust-lang/rust/pull/77809#issuecomment-707875732
 237     if (getSettingValue("use-system-theme") === null
 238         && getSettingValue("preferred-dark-theme") === null
 239         && darkThemes.indexOf(localStoredTheme) >= 0) {
 240         updateLocalStorage("preferred-dark-theme", localStoredTheme);
 241     }
 242
 243     // call the function to initialize the theme at least once!
 244     updateSystemTheme();
 245 } else {
 246     switchToSavedTheme();
 247 }
 248
 249 if (getSettingValue("source-sidebar-show") === "true") {
 250     // At this point in page load, `document.body` is not available yet.
 251     // Set a class on the `<html>` element instead.
 252     addClass(document.documentElement, "source-sidebar-expanded");
 253 }
 254
 255 // If we navigate away (for example to a settings page), and then use the back or
 256 // forward button to get back to a page, the theme may have changed in the meantime.
 257 // But scripts may not be re-loaded in such a case due to the bfcache
 258 // (https://web.dev/bfcache/). The "pageshow" event triggers on such navigations.
 259 // Use that opportunity to update the theme.
 260 // We use a setTimeout with a 0 timeout here to put the change on the event queue.
 261 // For some reason, if we try to change the theme while the `pageshow` event is
 262 // running, it sometimes fails to take effect. The problem manifests on Chrome,
 263 // specifically when talking to a remote website with no caching.
 264 window.addEventListener("pageshow", ev => {
 265     if (ev.persisted) {
 266         setTimeout(switchToSavedTheme, 0);
 267     }
 268 });