link to search ui

Author: dojutsu-user

sphinx_search/_static/js/rtd_sphinx_search.js

@@ -46,22 +46,47 @@ const debounce = (func, wait) => {
 /**
  * Take an object as parameter and convert it to
  * url params string.
- * Eg. if obj = { 'a': 1, 'b': 2 }, then it will return
- * the string a=1&b=2.
+ * Eg. if obj = { 'a': 1, 'b': 2, 'c': ['hello', 'world'] }, then it will return
+ * the string a=1&b=2&c=hello,world
  *
  * @param {Object} obj the object to be converted
- * @return {String} object in url params form
+ * @return {String|Array} object in url params form
  */
 const convertObjToUrlParams = obj => {
     const params = Object.keys(obj)
         .map(function(key) {
-            const s = key + "=" + obj[key];
-            return s;
+            if (_is_string(key)) {
+                const s = key + "=" + encodeURI(obj[key]);
+                return s;
+            }
         })
         .join("&");
     return params;
 };
 
+/**
+ * Adds/removes "rtd_search" url parameter to the url.
+ */
+const updateUrl = () => {
+    let origin = window.location.origin;
+    let path = window.location.pathname;
+    let url_params = $.getQueryParameters();
+
+    if (_is_string(SEARCH_QUERY)) {
+        url_params.rtd_search = SEARCH_QUERY;
+    } else {
+        delete url_params.rtd_search;
+    }
+
+    let window_location_search = convertObjToUrlParams(url_params);
+
+    // new url
+    const url = origin + path + "?" + window_location_search;
+
+    // update url
+    window.history.pushState({}, null, url);
+};
+
 /**
  * Create and return DOM nodes
  * with passed attributes.
@@ -552,8 +577,10 @@ const generateAndReturnInitialHtml = () => {
 
 /**
  * Opens the search modal.
+ * 
+ * @param {String} custom_query if a custom query is provided, initialise the value of input field with it
  */
-const showSearchModal = () => {
+const showSearchModal = custom_query => {
     // removes previous results (if there are any).
     removeResults();
 
@@ -568,7 +595,14 @@ const showSearchModal = () => {
             ".search__outer__input"
         );
         if (search_outer_input !== null) {
-            search_outer_input.value = "";
+            if (
+                typeof custom_query !== "undefined" &&
+                _is_string(custom_query)
+            ) {
+                search_outer_input.value = custom_query;
+            } else {
+                search_outer_input.value = "";
+            }
             search_outer_input.focus();
         }
     });
@@ -603,9 +637,13 @@ window.addEventListener("DOMContentLoaded", evt => {
         let initialHtml = generateAndReturnInitialHtml();
         document.body.innerHTML += initialHtml;
 
-        let search_outer_wrapper = document.querySelector('.search__outer__wrapper');
-        let search_outer_input = document.querySelector('.search__outer__input');
-        let cross_icon = document.querySelector('.search__cross');
+        let search_outer_wrapper = document.querySelector(
+            ".search__outer__wrapper"
+        );
+        let search_outer_input = document.querySelector(
+            ".search__outer__input"
+        );
+        let cross_icon = document.querySelector(".search__cross");
 
         // this denotes the search suggestion which is currently selected
         // via tha ArrowUp/ArrowDown keys.
@@ -624,7 +662,7 @@ window.addEventListener("DOMContentLoaded", evt => {
             COUNT = 0;
 
             let search_params = {
-                q: encodeURIComponent(SEARCH_QUERY),
+                q: SEARCH_QUERY,
                 project: project,
                 version: version,
                 language: language
@@ -649,6 +687,9 @@ window.addEventListener("DOMContentLoaded", evt => {
                 // is debounced here.
                 debounce(removeResults, 600)();
             }
+
+            // update URL
+            updateUrl();
         });
 
         search_outer_input.addEventListener("keydown", e => {
@@ -719,5 +760,19 @@ window.addEventListener("DOMContentLoaded", evt => {
                 removeSearchModal();
             }
         });
+
+        // if "rtd_search" is present in URL parameters,
+        // then open the search modal and show the results
+        // for the value of "rtd_search"
+        let url_params = $.getQueryParameters();
+        if (_is_array(url_params.rtd_search)) {
+            let query = decodeURIComponent(url_params.rtd_search);
+            showSearchModal(query);
+            search_outer_input.value = query;
+
+            let event = document.createEvent("Event");
+            event.initEvent("input", true, true);
+            search_outer_input.dispatchEvent(event);
+        }
     }
 });