').addClass('mt-4').addClass('search-result');
-
- $entry.append(
- $('
')
- .addClass('d-block')
- .css({
- fontSize: '1.2rem',
- })
- .attr('href', href)
- .text(doc.title)
- );
-
- $entry.append(
- $('').addClass('d-block text-muted').text(r.ref)
- );
-
- $entry.append($('').text(doc.excerpt));
+ };
- $searchResultBody.append($entry);
- });
- }
+ // Renders the search results when the input changes.
+ $searchInput.on('change', (event) => {
+ render($(event.target));
- $targetSearchInput.on('shown.bs.popover', () => {
- $('.search-result-close-button').on('click', () => {
- $targetSearchInput.val('');
- $targetSearchInput.trigger('change');
- });
- });
+ // Hide keyboard on mobile browser
+ $searchInput.blur();
+ });
- $targetSearchInput
- .data('content', $html[0].outerHTML)
- .popover('show');
- };
+ // Prevent reloading page by enter key on sidebar search.
+ $searchInput.closest('form').on('submit', () => {
+ return false;
+ });
});
})(jQuery);
diff --git a/assets/js/worker.js b/assets/js/worker.js
new file mode 100644
index 000000000..e463940af
--- /dev/null
+++ b/assets/js/worker.js
@@ -0,0 +1,99 @@
+/**
+ * This worker is responsible for loading the lunr index, searching the index and returning the results.
+ *
+ * It has 2 action types, 'init' and 'search'.
+ *
+ * 'init' action is used to load the lunr index and the raw index data.
+ * 'search' action is used to search the lunr index with the provided query.
+ */
+
+if (typeof importScripts === 'function') {
+ importScripts('https://unpkg.com/lunr@2.3.8/lunr.min.js');
+}
+
+let idx;
+const versionRegex = new RegExp("^\/docs\/([0-9\.]*|latest)\/");
+const resultDetails = new Map();
+let indexReadyPromise;
+
+self.onmessage = async function (event) {
+ if (event.data.type === 'init') {
+ // Initialize the lunr index and the raw index data.
+ indexReadyPromise = new Promise(async (resolve, reject) => {
+ try {
+ const rawIndex = await fetch(event.data.rawIndexUrl);
+ let json = await rawIndex.json();
+ json.forEach((doc) => {
+ resultDetails.set(doc.ref, {
+ version: doc.version,
+ title: doc.title,
+ excerpt: doc.excerpt,
+ });
+ });
+
+ const lunrIndex = await fetch(event.data.lunrIndexUrl);
+ json = await lunrIndex.json();
+ idx = lunr.Index.load(json);
+ resolve();
+ self.postMessage({ type: 'init', status: 'success' });
+ } catch (error) {
+ reject(error);
+ self.postMessage({ type: 'init', status: 'error', message: error.message });
+ }
+ });
+ } else if (event.data.type === 'search') {
+ // Search the lunr index with the provided query.
+ try {
+ await indexReadyPromise;
+ const regexResults = versionRegex.exec(event.data.currentPath);
+ const version = regexResults
+ ? regexResults[0]
+ : undefined;
+
+ const results = idx
+ .query((q) => {
+ const tokens = lunr.tokenizer(event.data.query.toLowerCase());
+ tokens.forEach((token) => {
+ const queryString = token.toString();
+ q.term(queryString, {
+ boost: 100,
+ });
+ q.term(queryString, {
+ wildcard: lunr.Query.wildcard.LEADING | lunr.Query.wildcard.TRAILING,
+ boost: 10,
+ });
+ q.term(queryString, {
+ editDistance: 2,
+ });
+ });
+ });
+
+ const docs = new Map();
+ let count = 0;
+
+ for (const result of results) {
+ if (count >= event.data.maxResults) {
+ break;
+ }
+
+ if (resultDetails.get(result.ref) === undefined) {
+ continue;
+ }
+
+ if (version === undefined) {
+ docs.set(result.ref, resultDetails.get(result.ref));
+ } else if (result.ref.startsWith(version)) {
+ docs.set(result.ref, resultDetails.get(result.ref));
+ } else {
+ continue;
+ }
+
+ count++;
+ }
+
+ self.postMessage({ type: 'search', status: 'success', query: event.data.query , docs: docs });
+ } catch (error) {
+ self.postMessage({ type: 'search', status: 'error', message: 'Index not ready' });
+ }
+ }
+};
\ No newline at end of file
diff --git a/layouts/docs/baseof.html b/layouts/docs/baseof.html
index 64edd70ef..c8e57e24a 100644
--- a/layouts/docs/baseof.html
+++ b/layouts/docs/baseof.html
@@ -26,5 +26,7 @@
{{ partial "footer.html" . }}