|
| 1 | +"use strict"; |
| 2 | + |
| 3 | +(function () { |
| 4 | + var searchForm = document.getElementById("search-form"); |
| 5 | + var searchBox = document.getElementById("search-box"); |
| 6 | + var spinner = document.getElementById("spinner"); |
| 7 | + var searchResultsContainer = document.getElementById("search-results-container"); |
| 8 | + |
| 9 | + // Use a worker to create the index in the background. |
| 10 | + var worker = new Worker("/js/search-worker.js"); |
| 11 | + worker.onmessage = function (message) { |
| 12 | + var payload = message.data.payload; |
| 13 | + displaySearchResults(payload.results); |
| 14 | + }; |
| 15 | + |
| 16 | + // Extract the query from the browser's URL, set the search-box to the query, |
| 17 | + // and kick-off the search by sending a message to the worker. |
| 18 | + var query = getQueryVariable("q"); |
| 19 | + if (query) { |
| 20 | + searchBox.value = query; |
| 21 | + sendSearchMessage(query); |
| 22 | + } else { |
| 23 | + displaySearchResults([]); |
| 24 | + } |
| 25 | + |
| 26 | + // To speed up subsequent searches on this page, if the browser supports pushState, |
| 27 | + // add a listener to the search form's submit event that prevents the browser from |
| 28 | + // doing an actual GET request navigation on searches. Instead, we just proceed with |
| 29 | + // the new search without navigating and update the browser location with the new |
| 30 | + // query string programmatically. |
| 31 | + if (history.pushState) { |
| 32 | + searchForm.addEventListener("submit", function (e) { |
| 33 | + e.preventDefault(); |
| 34 | + |
| 35 | + var query = searchBox.value; |
| 36 | + if (query) { |
| 37 | + // Update the browser's location with the new query string. |
| 38 | + var newurl = window.location.protocol + "//" + window.location.host + |
| 39 | + window.location.pathname + "?q=" + encodeURIComponent(query); |
| 40 | + history.pushState({ path: newurl }, "", newurl); |
| 41 | + |
| 42 | + // Kick-off the new search. |
| 43 | + sendSearchMessage(query); |
| 44 | + } |
| 45 | + |
| 46 | + return false; |
| 47 | + }); |
| 48 | + } |
| 49 | + |
| 50 | + // If we're navigating back/forward from a history.pushState, |
| 51 | + // then intercept and search for the term again. |
| 52 | + window.onpopstate = function (event) { |
| 53 | + var query = getQueryVariable("q"); |
| 54 | + if (query) { |
| 55 | + searchBox.value = query; |
| 56 | + sendSearchMessage(query); |
| 57 | + } |
| 58 | + } |
| 59 | + |
| 60 | + // Extracts a query string variable from the browser's location. |
| 61 | + function getQueryVariable(variable) { |
| 62 | + var query = window.location.search.substring(1); |
| 63 | + var vars = query.split("&"); |
| 64 | + |
| 65 | + for (var i = 0; i < vars.length; i++) { |
| 66 | + var pair = vars[i].split("="); |
| 67 | + |
| 68 | + if (pair[0] === variable) { |
| 69 | + return decodeURIComponent(pair[1].replace(/\+/g, "%20")); |
| 70 | + } |
| 71 | + } |
| 72 | + } |
| 73 | + |
| 74 | + // Sends a message to the worker to kick-off a search. |
| 75 | + function sendSearchMessage(query) { |
| 76 | + worker.postMessage({ type: "search", payload: query }); |
| 77 | + } |
| 78 | + |
| 79 | + // Display the results of the search. |
| 80 | + function displaySearchResults(results) { |
| 81 | + // Hide the spinner. |
| 82 | + spinner.style.display = "none"; |
| 83 | + |
| 84 | + if (results.length) { |
| 85 | + // Group the results by category. |
| 86 | + var categoryMap = {}; |
| 87 | + for (var i = 0; i < results.length; i++) { |
| 88 | + var result = results[i]; |
| 89 | + var categoryName = getCategoryName(result.url); |
| 90 | + var category = categoryMap[categoryName] = categoryMap[categoryName] || []; |
| 91 | + prepareResult(result, categoryName); |
| 92 | + category.push(result); |
| 93 | + } |
| 94 | + |
| 95 | + // Build up the HTML to display. |
| 96 | + var appendString = ""; |
| 97 | + for (var i = 0; i < categories.length; i++) { |
| 98 | + var categoryName = categories[i].name; |
| 99 | + var category = categoryMap[categoryName]; |
| 100 | + if (category && category.length > 0) { |
| 101 | + appendString += buildCategoryString(categoryName, category); |
| 102 | + } |
| 103 | + } |
| 104 | + searchResultsContainer.innerHTML = appendString; |
| 105 | + } else { |
| 106 | + searchResultsContainer.innerHTML = "<p>No results found.</p>"; |
| 107 | + } |
| 108 | + } |
| 109 | + |
| 110 | + var defaultCategory = "Other"; |
| 111 | + var categories = [ |
| 112 | + { |
| 113 | + name: "APIs", |
| 114 | + predicate: function (url) { |
| 115 | + return url.startsWith("/reference/pkg/"); |
| 116 | + } |
| 117 | + }, |
| 118 | + { |
| 119 | + name: "CLI", |
| 120 | + predicate: function (url) { |
| 121 | + return url.startsWith("/reference/cli/") || url === "/reference/commands.html"; |
| 122 | + } |
| 123 | + }, |
| 124 | + { |
| 125 | + name: "Tutorials", |
| 126 | + predicate: function (url) { |
| 127 | + return url.startsWith("/quickstart/"); |
| 128 | + } |
| 129 | + }, |
| 130 | + { |
| 131 | + name: defaultCategory, |
| 132 | + predicate: function (url) { |
| 133 | + return true; |
| 134 | + } |
| 135 | + }, |
| 136 | + ]; |
| 137 | + |
| 138 | + function getCategoryName(url) { |
| 139 | + for (var i = 0; i < categories.length; i++) { |
| 140 | + var category = categories[i]; |
| 141 | + if (category.predicate(url)) { |
| 142 | + return category.name; |
| 143 | + } |
| 144 | + } |
| 145 | + return defaultCategory; |
| 146 | + } |
| 147 | + |
| 148 | + function prepareResult(result, categoryName) { |
| 149 | + switch (categoryName) { |
| 150 | + case "APIs": |
| 151 | + if (result.title.startsWith("Module ")) { |
| 152 | + result.display = result.title.substring("Module ".length); |
| 153 | + result.type = "module"; |
| 154 | + return; |
| 155 | + } else if (result.title.startsWith("Package ")) { |
| 156 | + result.display = result.title.substring("Package ".length); |
| 157 | + result.type = "package"; |
| 158 | + return; |
| 159 | + } |
| 160 | + break; |
| 161 | + |
| 162 | + case "CLI": |
| 163 | + if (result.title.length === 0 && result.url.startsWith("/reference/cli/")) { |
| 164 | + var regex = /\/reference\/cli\/([a-z_]+).html/gm; |
| 165 | + var match = regex.exec(result.url) |
| 166 | + if (match !== null) { |
| 167 | + result.display = match[1].replace(/_/g, " "); |
| 168 | + return; |
| 169 | + } |
| 170 | + } |
| 171 | + break; |
| 172 | + } |
| 173 | + |
| 174 | + result.display = result.title || result.url; |
| 175 | + } |
| 176 | + |
| 177 | + function buildCategoryString(categoryName, category) { |
| 178 | + var appendString = "<div class='search-results'><h3>" + categoryName + " (" + category.length + ")</h3>"; |
| 179 | + |
| 180 | + // Display the top 5 results first. |
| 181 | + appendString += "<ul>"; |
| 182 | + var topResults = category.splice(0, 5); |
| 183 | + for (var i = 0; i < topResults.length; i++) { |
| 184 | + var item = topResults[i]; |
| 185 | + var prefix = getPrefix(item, categoryName); |
| 186 | + appendString += "<li class='top'><a href='" + item.url + "'>" + prefix + item.display + "</a>"; |
| 187 | + } |
| 188 | + appendString += "</ul>"; |
| 189 | + |
| 190 | + // Now display any remaining results, sorted alphabetically. |
| 191 | + if (category.length > 0) { |
| 192 | + category.sort(function (l, r) { |
| 193 | + return l.display.toUpperCase() > r.display.toUpperCase() ? 1 : -1; |
| 194 | + }); |
| 195 | + appendString += "<ul>"; |
| 196 | + for (var i = 0; i < category.length; i++) { |
| 197 | + var item = category[i]; |
| 198 | + var prefix = getPrefix(item, categoryName); |
| 199 | + appendString += "<li><a href='" + item.url + "'>" + prefix + item.display + "</a>"; |
| 200 | + } |
| 201 | + appendString += "</ul>"; |
| 202 | + } |
| 203 | + |
| 204 | + appendString += "</div>"; |
| 205 | + return appendString; |
| 206 | + } |
| 207 | + |
| 208 | + function getPrefix(result, categoryName) { |
| 209 | + if (result.type) { |
| 210 | + switch (result.type) { |
| 211 | + case "module": |
| 212 | + return "<span class='symbol module'></span>"; |
| 213 | + case "package": |
| 214 | + return "<span class='symbol package'></span>" |
| 215 | + } |
| 216 | + } |
| 217 | + |
| 218 | + return ""; |
| 219 | + } |
| 220 | +})(); |
0 commit comments