feat: allow for disabling of active hash on scroll (#489)

vuejs · May 24, 2018 · 4c09627 · 4c09627
1 parent 0570777
commit 4c09627
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 0 deletions.
diff --git a/docs/default-theme-config/README.md b/docs/default-theme-config/README.md
@@ -142,6 +142,18 @@ sidebarDepth: 2
 ---
 ```
 
+### Active Header Links
+
+By default, the nested header links and the hash in the URL are updated as the user scrolls to view the different sections of the page. This behavior can be disabled with the following theme config:
+
+``` js
+module.exports = {
+  themeConfig: {
+    disableActiveHash: true, // boolean
+  }
+}
+```
+
 ### Sidebar Groups
 
 You can divide sidebar links into multiple groups by using objects:

diff --git a/lib/default-theme/Layout.vue b/lib/default-theme/Layout.vue
@@ -136,6 +136,10 @@ export default {
       this.setActiveHash()
     }, 300),
     setActiveHash () {
+      if (this.$site.themeConfig.disableActiveHash) {
+        return
+      }
+
       const sidebarLinks = [].slice.call(document.querySelectorAll('.sidebar-link'))
       const anchors = [].slice.call(document.querySelectorAll('.header-anchor'))
         .filter(anchor => sidebarLinks.some(sidebarLink => sidebarLink.hash === anchor.hash))