feat: highlight nav item in onPageNav ToC (#1524)

* feat: highlight nav item in onPageNav ToC

* fix: use es5 in browser scripts, update documentation, css refactoring

* fix: removes smooth scroll

* fix: removes unnecessary codeblock , undo css formatting issues, modify scrip load url

* fix: update scrollspy script comments

packages/docusaurus-1.x/lib/core/Head.js

@@ -172,6 +172,7 @@ class Head extends React.Component {
             }}
           />
         )}
+        <script src={`${this.props.config.baseUrl}js/scrollSpy.js`} />
         {this.props.config.usePrism && (
           <link
             rel="stylesheet"

packages/docusaurus-1.x/lib/static/css/main.css

@@ -1958,23 +1958,27 @@ input::placeholder {
 }
 
 .onPageNav::-webkit-scrollbar-track {
-  background: #f1f1f1; 
+  background: #f1f1f1;
   border-radius: 10px;
 }
 
 .onPageNav::-webkit-scrollbar-thumb {
-  background: #888; 
+  background: #888;
   border-radius: 10px;
 }
 
 .onPageNav::-webkit-scrollbar-thumb:hover {
-  background: #555; 
+  background: #555;
 }
 
 .onPageNav a {
   color: #717171;
 }
 
+.onPageNav .toc-headings > li > a.active {
+  font-weight: 600;
+}
+
 .onPageNav ul {
   list-style: none;
 }

packages/docusaurus-1.x/lib/static/js/scrollSpy.js

@@ -0,0 +1,66 @@
+/**
+ * Copyright (c) 2017-present, Facebook, Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+/* eslint-disable prefer-arrow-callback */
+(function scrollSpy() {
+  const OFFSET = 10;
+  let timer;
+  let headingsCache;
+  const findHeadings = function findHeadings() {
+    return headingsCache || document.querySelectorAll('.toc-headings > li > a');
+  };
+  const onScroll = function onScroll() {
+    if (timer) {
+      // throttle
+      return;
+    }
+    timer = setTimeout(function() {
+      timer = null;
+      let activeNavFound = false;
+      const headings = findHeadings(); // toc nav anchors
+      /**
+       * On every call, try to find header right after  <-- next header
+       * the one whose content is on the current screen <-- highlight this
+       */
+      for (let i = 0; i < headings.length; i++) {
+        // headings[i] is current element
+        // if an element is already active, then current element is not active
+        // if no element is already active, then current element is active
+        let currNavActive = !activeNavFound;
+        /**
+         * Enter the following check up only when an active nav header is not yet found
+         * Then, check the bounding rectangle of the next header
+         * The headers that are scrolled passed will have negative bounding rect top
+         * So the first one with positive bounding rect top will be the nearest next header
+         */
+        if (currNavActive && i < headings.length - 1) {
+          const next = headings[i + 1].href.split('#')[1];
+          const nextHeader = document.getElementById(next);
+          const top = nextHeader.getBoundingClientRect().top;
+          currNavActive = top > OFFSET;
+        }
+        /**
+         * Stop searching once a first such header is found,
+         * this makes sure the highlighted header is the most current one
+         */
+        if (currNavActive) {
+          activeNavFound = true;
+          headings[i].classList.add('active');
+        } else {
+          headings[i].classList.remove('active');
+        }
+      }
+    }, 100);
+  };
+  document.addEventListener('scroll', onScroll);
+  document.addEventListener('resize', onScroll);
+  document.addEventListener('DOMContentLoaded', function() {
+    // Cache the headings once the page has fully loaded.
+    headingsCache = findHeadings();
+    onScroll();
+  });
+})();