From 9941786e0667706454d2dd626b502eb6c71ce2a2 Mon Sep 17 00:00:00 2001
From: "F. Carter Wheatley" <carter@odyn.ai>
Date: Thu, 25 Oct 2018 11:22:51 -0500
Subject: [PATCH] Implement a sidebar search to make it easier to find UI
 components.

---
 .gitignore                         |  1 +
 server/files/javascript/docs.js    | 95 ++++++++++++++++++++++++++++++
 server/files/stylesheets/docs.css  | 13 ++++
 server/partials/site-menu.html.eco |  6 ++
 4 files changed, 115 insertions(+)

diff --git a/.gitignore b/.gitignore
index 759dbc39d1..057251566e 100755
--- a/.gitignore
+++ b/.gitignore
@@ -30,3 +30,4 @@ nbproject
 *.sublime-project
 *.sublime-workspace
 .brofile
+.idea
diff --git a/server/files/javascript/docs.js b/server/files/javascript/docs.js
index 1c3d1b761e..b201d47633 100644
--- a/server/files/javascript/docs.js
+++ b/server/files/javascript/docs.js
@@ -1230,6 +1230,98 @@ semantic.ready = function() {
           ;
         })
       ;
+    },
+
+    setupSidebarSearch: function(inputSelector, sectionsSelector) {
+      var
+        $sidebarInput = $(inputSelector),
+        $sidebarSections = $(sectionsSelector),
+        sidebar = [],
+        ENTER_KEY_CODE = 13,
+        ARROW_UP_KEY_CODE = 38,
+        ARROW_DOWN_KEY_CODE = 40,
+        activeFilteredIndex = 0,
+        $filteredItems = [],
+        pressEnterDOMElement = '<span class="press-enter">Press Enter</span>'
+      ;
+
+      // cache jquery references to nodes
+      $sidebarSections.each(function(idx, sectionDOM) {
+        var elements = {
+          $section: $(sectionDOM),
+          $header: null,
+          $items: []
+        };
+
+        elements.$header = $(elements.$section.children('.header'));
+        elements.$section.find('.item').each(function(itemIDX, itemDOM) {
+          elements.$items.push($(itemDOM));
+        });
+        sidebar.push(elements);
+      });
+
+      $sidebarInput.on('keyup', function(ev) {
+        var
+          searchText = ev.currentTarget.value.toLowerCase(),
+          $pressEnter = $('.press-enter')
+        ;
+
+        if (searchText && $filteredItems.length > 0) {
+          if (ev.keyCode === ENTER_KEY_CODE) {
+            $filteredItems[activeFilteredIndex][0].click();
+            return;
+          } else if ([ARROW_UP_KEY_CODE, ARROW_DOWN_KEY_CODE].includes(ev.keyCode)) {
+            $pressEnter.detach();
+
+            $filteredItems[activeFilteredIndex].removeClass('active');
+
+            if (ev.keyCode === ARROW_UP_KEY_CODE) {
+              activeFilteredIndex = Math.max(activeFilteredIndex - 1, 0);
+            } else {
+              activeFilteredIndex = Math.min(activeFilteredIndex + 1, $filteredItems.length - 1);
+            }
+
+            $filteredItems[activeFilteredIndex].addClass('active');
+            $filteredItems[activeFilteredIndex].append(pressEnterDOMElement);
+            return;
+          }
+        }
+
+        $filteredItems = [];
+        activeFilteredIndex = 0;
+        $pressEnter.detach();
+
+        sidebar.forEach(function(section) {
+          // check if the section contains the text at all
+          if (!section.$section.text().toLowerCase().includes(searchText)) {
+            section.$section.toggleClass('hide', true);
+            return;
+          }
+          section.$section.toggleClass('hide', false);
+
+          // see if the user searched for the header of the section
+          var doesHeaderContainText = section.$header.text().toLowerCase().includes(searchText);
+
+          // check each item to see if it contains the search text
+          section.$items.forEach(function($item) {
+            $item.removeClass('active');
+            var doesItemContainText = $item.text().toLowerCase().includes(searchText);
+
+            // item is hidden unless the header of the section contains the search text
+            var hideItem = !doesItemContainText && !doesHeaderContainText;
+            $item.toggleClass('hide', hideItem);
+
+            if (searchText && !hideItem) {
+              $filteredItems.push($item);
+            }
+          });
+        });
+
+        if ($filteredItems.length > 0) {
+          $filteredItems[activeFilteredIndex].addClass('active');
+          $filteredItems[activeFilteredIndex].append(pressEnterDOMElement);
+        }
+      });
     }
   };
 
@@ -1253,6 +1345,9 @@ semantic.ready = function() {
   // register less files
   window.less.registerStylesheets();
 
+  // there are 2 sidebar sections, set them up individually
+  handler.setupSidebarSearch('#example #toc input', '#toc .item:has(> .header)');
+  handler.setupSidebarSearch('.full.height .toc input', '.toc .item:has(> .header)');
 
   // load page tabs
   if( $pageTabs.length > 0 ) {
diff --git a/server/files/stylesheets/docs.css b/server/files/stylesheets/docs.css
index 6e59b2f544..4a19805cdc 100755
--- a/server/files/stylesheets/docs.css
+++ b/server/files/stylesheets/docs.css
@@ -2010,6 +2010,7 @@ code .chunk {
   z-index: 1;
   background-color: #1b1c1d;
   width: 250px;
+  height: 100%;
   -webkit-box-flex: 0;
   -webkit-flex: 0 0 auto;
       -ms-flex: 0 0 auto;
@@ -2061,6 +2062,18 @@ code .chunk {
   padding-top: 2em;
 }
 
+#example .toc .item.hide,
+#example .toc .item .item.hide,
+#example #toc.sidebar .item.hide,
+#example #toc.sidebar .item .item.hide {
+  display: none;
+}
+
+.press-enter {
+  float: right;
+  color: #35bdb2;
+}
+
 /*******************************
       Definition Container
 *******************************/
diff --git a/server/partials/site-menu.html.eco b/server/partials/site-menu.html.eco
index 61b79ae3c2..f65340eb2f 100644
--- a/server/partials/site-menu.html.eco
+++ b/server/partials/site-menu.html.eco
@@ -19,6 +19,12 @@
 <a class="item" href="/introduction/new.html">
   <b>New in 2.4</b>
 </a>
+<div class="item">
+  <div class="ui inverted transparent icon input">
+    <i class="search icon"></i>
+    <input type="text" placeholder="Search...">
+  </div>
+</div>
 <div class="item">
   <div class="<%= if @document.elementType is 'introduction' then 'active ' %>header">Introduction</div>
   <div class="menu">