src/librustdoc/html/static/js/settings.js

   1 // Local js definitions:
   2 /* global getSettingValue, getVirtualKey, updateLocalStorage, updateSystemTheme */
   3 /* global addClass, removeClass, onEach, onEachLazy, NOT_DISPLAYED_ID */
   4 /* global MAIN_ID, getVar, getSettingsButton, switchDisplayedElement, getNotDisplayedElem */
   5
   6 "use strict";
   7
   8 (function () {
   9     const isSettingsPage = window.location.pathname.endsWith("/settings.html");
  10
  11     function changeSetting(settingName, value) {
  12         updateLocalStorage(settingName, value);
  13
  14         switch (settingName) {
  15             case "theme":
  16             case "preferred-dark-theme":
  17             case "preferred-light-theme":
  18             case "use-system-theme":
  19                 updateSystemTheme();
  20                 updateLightAndDark();
  21                 break;
  22         }
  23     }
  24
  25     function handleKey(ev) {
  26         // Don't interfere with browser shortcuts
  27         if (ev.ctrlKey || ev.altKey || ev.metaKey) {
  28             return;
  29         }
  30         switch (getVirtualKey(ev)) {
  31             case "Enter":
  32             case "Return":
  33             case "Space":
  34                 ev.target.checked = !ev.target.checked;
  35                 ev.preventDefault();
  36                 break;
  37         }
  38     }
  39
  40     function showLightAndDark() {
  41         addClass(document.getElementById("theme").parentElement, "hidden");
  42         removeClass(document.getElementById("preferred-light-theme").parentElement, "hidden");
  43         removeClass(document.getElementById("preferred-dark-theme").parentElement, "hidden");
  44     }
  45
  46     function hideLightAndDark() {
  47         addClass(document.getElementById("preferred-light-theme").parentElement, "hidden");
  48         addClass(document.getElementById("preferred-dark-theme").parentElement, "hidden");
  49         removeClass(document.getElementById("theme").parentElement, "hidden");
  50     }
  51
  52     function updateLightAndDark() {
  53         if (getSettingValue("use-system-theme") !== "false") {
  54             showLightAndDark();
  55         } else {
  56             hideLightAndDark();
  57         }
  58     }
  59
  60     function setEvents(settingsElement) {
  61         updateLightAndDark();
  62         onEachLazy(settingsElement.getElementsByClassName("slider"), elem => {
  63             const toggle = elem.previousElementSibling;
  64             const settingId = toggle.id;
  65             const settingValue = getSettingValue(settingId);
  66             if (settingValue !== null) {
  67                 toggle.checked = settingValue === "true";
  68             }
  69             toggle.onchange = function() {
  70                 changeSetting(this.id, this.checked);
  71             };
  72             toggle.onkeyup = handleKey;
  73             toggle.onkeyrelease = handleKey;
  74         });
  75         onEachLazy(settingsElement.getElementsByClassName("select-wrapper"), elem => {
  76             const select = elem.getElementsByTagName("select")[0];
  77             const settingId = select.id;
  78             const settingValue = getSettingValue(settingId);
  79             if (settingValue !== null) {
  80                 select.value = settingValue;
  81             }
  82             select.onchange = function() {
  83                 changeSetting(this.id, this.value);
  84             };
  85         });
  86         onEachLazy(settingsElement.querySelectorAll("input[type=\"radio\"]"), elem => {
  87             const settingId = elem.name;
  88             const settingValue = getSettingValue(settingId);
  89             if (settingValue !== null && settingValue !== "null") {
  90                 elem.checked = settingValue === elem.value;
  91             }
  92             elem.addEventListener("change", ev => {
  93                 changeSetting(ev.target.name, ev.target.value);
  94             });
  95         });
  96     }
  97
  98     /**
  99      * This function builds the sections inside the "settings page". It takes a `settings` list
 100      * as argument which describes each setting and how to render it. It returns a string
 101      * representing the raw HTML.
 102      *
 103      * @param {Array<Object>} settings
 104      *
 105      * @return {string}
 106      */
 107     function buildSettingsPageSections(settings) {
 108         let output = "";
 109
 110         for (const setting of settings) {
 111             output += `<div class="setting-line">`;
 112             const js_data_name = setting["js_name"];
 113             const setting_name = setting["name"];
 114
 115             if (setting["options"] !== undefined) {
 116                 // This is a select setting.
 117                 output += `<div class="radio-line" id="${js_data_name}">\
 118                         <span class="setting-name">${setting_name}</span>\
 119                         <div class="choices">`;
 120                 onEach(setting["options"], option => {
 121                     const checked = option === setting["default"] ? " checked" : "";
 122
 123                     output += `<label for="${js_data_name}-${option}" class="choice">\
 124                            <input type="radio" name="${js_data_name}" \
 125                                 id="${js_data_name}-${option}" value="${option}"${checked}>\
 126                            ${option}\
 127                          </label>`;
 128                 });
 129                 output += "</div></div>";
 130             } else {
 131                 // This is a toggle.
 132                 const checked = setting["default"] === true ? " checked" : "";
 133                 output += `
 134                     <label class="toggle">
 135                         <input type="checkbox" id="${js_data_name}"${checked}>
 136                         <span class="slider"></span>
 137                     </label>
 138                     <div>${setting_name}</div>`;
 139             }
 140             output += "</div>";
 141         }
 142         return output;
 143     }
 144
 145     /**
 146      * This function builds the "settings page" and returns the generated HTML element.
 147      *
 148      * @return {HTMLElement}
 149      */
 150     function buildSettingsPage() {
 151         const themes = getVar("themes").split(",");
 152         const settings = [
 153             {
 154                 "name": "Use system theme",
 155                 "js_name": "use-system-theme",
 156                 "default": true,
 157             },
 158             {
 159                 "name": "Theme",
 160                 "js_name": "theme",
 161                 "default": "light",
 162                 "options": themes,
 163             },
 164             {
 165                 "name": "Preferred light theme",
 166                 "js_name": "preferred-light-theme",
 167                 "default": "light",
 168                 "options": themes,
 169             },
 170             {
 171                 "name": "Preferred dark theme",
 172                 "js_name": "preferred-dark-theme",
 173                 "default": "dark",
 174                 "options": themes,
 175             },
 176             {
 177                 "name": "Auto-hide item contents for large items",
 178                 "js_name": "auto-hide-large-items",
 179                 "default": true,
 180             },
 181             {
 182                 "name": "Auto-hide item methods' documentation",
 183                 "js_name": "auto-hide-method-docs",
 184                 "default": false,
 185             },
 186             {
 187                 "name": "Auto-hide trait implementation documentation",
 188                 "js_name": "auto-hide-trait-implementations",
 189                 "default": false,
 190             },
 191             {
 192                 "name": "Directly go to item in search if there is only one result",
 193                 "js_name": "go-to-only-result",
 194                 "default": false,
 195             },
 196             {
 197                 "name": "Show line numbers on code examples",
 198                 "js_name": "line-numbers",
 199                 "default": false,
 200             },
 201             {
 202                 "name": "Disable keyboard shortcuts",
 203                 "js_name": "disable-shortcuts",
 204                 "default": false,
 205             },
 206         ];
 207
 208         // Then we build the DOM.
 209         const el = document.createElement("section");
 210         el.id = "settings";
 211         let innerHTML = `
 212             <div class="main-heading">
 213                 <h1 class="fqn">
 214                     <span class="in-band">Rustdoc settings</span>
 215                 </h1>
 216                 <span class="out-of-band">`;
 217
 218         if (isSettingsPage) {
 219             innerHTML +=
 220                 `<a id="back" href="javascript:void(0)" onclick="history.back();">Back</a>`;
 221         } else {
 222             innerHTML +=
 223                 `<a id="back" href="javascript:void(0)" onclick="switchDisplayedElement(null);">\
 224                     Back</a>`;
 225         }
 226         innerHTML += `</span>
 227             </div>
 228             <div class="settings">${buildSettingsPageSections(settings)}</div>`;
 229
 230         el.innerHTML = innerHTML;
 231
 232         if (isSettingsPage) {
 233             document.getElementById(MAIN_ID).appendChild(el);
 234         } else {
 235             getNotDisplayedElem().appendChild(el);
 236         }
 237         return el;
 238     }
 239
 240     const settingsMenu = buildSettingsPage();
 241
 242     if (isSettingsPage) {
 243         // We replace the existing "onclick" callback to do nothing if clicked.
 244         getSettingsButton().onclick = function(event) {
 245             event.preventDefault();
 246         };
 247     } else {
 248         // We replace the existing "onclick" callback.
 249         const settingsButton = getSettingsButton();
 250         settingsButton.onclick = function(event) {
 251             event.preventDefault();
 252             if (settingsMenu.parentElement.id === NOT_DISPLAYED_ID) {
 253                 switchDisplayedElement(settingsMenu);
 254             } else {
 255                 window.hideSettings();
 256             }
 257         };
 258         window.hideSettings = function() {
 259             switchDisplayedElement(null);
 260         };
 261     }
 262
 263     // We now wait a bit for the web browser to end re-computing the DOM...
 264     setTimeout(() => {
 265         setEvents(settingsMenu);
 266         // The setting menu is already displayed if we're on the settings page.
 267         if (!isSettingsPage) {
 268             switchDisplayedElement(settingsMenu);
 269         }
 270         removeClass(getSettingsButton(), "rotate");
 271     }, 0);
 272 })();