Added enableLocationHash option

lcdsantos · Nov 14, 2017 · 645f9ea · 645f9ea
1 parent 5508a42
commit 645f9ea
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -16,7 +16,7 @@ Include MenuSpy
 
 `MenuSpy` will be available in the global scope.
 
-Or install with NPM and require as a module
+Or install via NPM/Yarn and require as a module
 
 ```
 npm install menuspy
@@ -57,10 +57,11 @@ The `MenuSpy()` constructor accepts two arguments: the container element and an
 
 ## Options
 
-| Option             | Type     | Default                             | Description                                                              |
-| ------------------ | -------- | ----------------------------------- | ------------------------------------------------------------------------ |
-| `menuItemSelector` | String   | `a[href^="#"]`                      | Menu items selector.                                                     |
-| `activeClass`      | String   | `active`                            | Class applied on menu item relative to the currently visible section.    |
-| `threshold`        | Integer  | `15`                                | Ammount of space between your menu and the next section to be activated. |
-| `hashTimeout`      | Integer  | `600`                               | Timeout to apply browser's hash location.                                |
-| `callback`         | Function | `function(currentItem) {}`          | A function to be called every time a new menu item activates.            |
+| Option               | Type     | Default                    | Description                                                              |
+| ---------------------| -------- | -------------------------- | ------------------------------------------------------------------------ |
+| `menuItemSelector`   | String   | `a[href^="#"]`             | Menu items selector.                                                     |
+| `activeClass`        | String   | `active`                   | Class applied on menu item relative to the currently visible section.    |
+| `threshold`          | Integer  | `15`                       | Ammount of space between your menu and the next section to be activated. |
+| `enableLocationHash` | Boolean  | `true`                     | Enable or disable browser's hash location change.                        |
+| `hashTimeout`        | Integer  | `600`                      | Timeout to apply browser's hash location.                                |
+| `callback`           | Function | `function(currentItem) {}` | A function to be called every time a new menu item activates.            |
diff --git a/dist/menuspy.js b/dist/menuspy.js
@@ -75,11 +75,12 @@ var MenuSpy = function MenuSpy(element, options) {
   }
 
   var defaults = {
-    menuItemSelector: 'a[href^="#"]',
-    activeClass   : 'active',
-    threshold     : 15,
-    hashTimeout   : 600,
-    callback      : null
+    menuItemSelector : 'a[href^="#"]',
+    activeClass      : 'active',
+    threshold        : 15,
+    enableLocationHash : true,
+    hashTimeout      : 600,
+    callback         : null
   };
 
   this.element = element;
@@ -138,7 +139,11 @@ MenuSpy.prototype.activateItem = function activateItem (inViewElm) {
   if (!inViewElm) {
     this.scrollItems.forEach(function (item) { return utils.removeClass(item.elm.parentNode, activeClass); });
     this.lastInViewElm = null;
-    this.debouncedHashFn();
+
+    if (this.enableLocationHash) {
+      this.debouncedHashFn();
+    }
+
     return;
   }
 
@@ -155,7 +160,9 @@ MenuSpy.prototype.activateItem = function activateItem (inViewElm) {
           callback.call(this$1, item);
         }
 
-        this$1.debouncedHashFn();
+        if (this$1.enableLocationHash) {
+          this$1.debouncedHashFn();
+        }
       }
     });
   }

diff --git a/dist/menuspy.min.js b/dist/menuspy.min.js
diff --git a/src/menuspy.js b/src/menuspy.js
@@ -7,11 +7,12 @@ class MenuSpy {
     }
 
     const defaults = {
-      menuItemSelector: 'a[href^="#"]',
-      activeClass     : 'active',
-      threshold       : 15,
-      hashTimeout     : 600,
-      callback        : null
+      menuItemSelector   : 'a[href^="#"]',
+      activeClass        : 'active',
+      threshold          : 15,
+      enableLocationHash : true,
+      hashTimeout        : 600,
+      callback           : null
     };
 
     this.element = element;
@@ -66,7 +67,11 @@ class MenuSpy {
     if (!inViewElm) {
       this.scrollItems.forEach((item) => utils.removeClass(item.elm.parentNode, activeClass));
       this.lastInViewElm = null;
-      this.debouncedHashFn();
+
+      if (this.enableLocationHash) {
+        this.debouncedHashFn();
+      }
+
       return;
     }
 
@@ -83,7 +88,9 @@ class MenuSpy {
             callback.call(this, item);
           }
 
-          this.debouncedHashFn();
+          if (this.enableLocationHash) {
+            this.debouncedHashFn();
+          }
         }
       });
     }