Merge pull request #11 from pettiboy/pull#10

✨ NEW: updateHistoryStack prop

Author: pettiboy

CHANGELOG.md

@@ -2,6 +2,17 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.2.0] - 2022-12-29
+
+### Added
+
+- Option to disable the URL getting updated by setting `updateHistoryStack` to `false`.
+
+### Fixed
+
+- Error when using `module` with `gatsby` or `next.js`.
+- use `replaceState` instead of `pushState` to avoid polluting history.
+
 ## [2.1.0] - 2021-11-13
 
 ### Added

README.md

@@ -140,6 +140,7 @@ html {
 | `useDataAttribute` | `string`  | To customize the string after `data-`                                                                     | `"to-scrollspy-id"`   | no       |
 | `activeClass`      | `string`  | To customize the `class` added when the `Element` in view                                                 | `"active-scroll-spy"` | no       |
 | `useBoxMethod`     | `boolean` | Set to `false` if you want your spy to be active only if more than `50%` of that `div` is in the viewport | `true`                | no       |
+| `updateHistoryStack` | `boolean` | Set to `false` to disable the URL getting automatically updated when scrolling                          | `true`                | no
 
 ##
 

demo-app/package-lock.json

@@ -15,7 +15,7 @@
     "react-dom": "^17.0.2",
     "react-router-dom": "^6.0.2",
     "react-scripts": "4.0.3",
-    "react-ui-scrollspy": "file:react-ui-scrollspy-2.0.1.tgz",
+    "react-ui-scrollspy": "file:react-ui-scrollspy-2.2.0.tgz",
     "typescript": "^4.4.4",
     "web-vitals": "^1.1.2"
   },

demo-app/package.json

@@ -14,10 +14,10 @@ creates a `.tgz`
 ```bash
 npm run build
 npm pack
-mv react-ui-scrollspy-2.1.0.tgz ./demo-app
+mv react-ui-scrollspy-2.2.0.tgz ./demo-app
 cd demo-app
 npm uninstall react-ui-scrollspy
-npm install react-ui-scrollspy-2.1.0.tgz --production
+npm install react-ui-scrollspy-2.2.0.tgz --production
 cd ..
 ```
 

dev.md

@@ -10,6 +10,7 @@ interface ScrollSpyProps {
     useDataAttribute?: string;
     activeClass?: string;
     useBoxMethod?: boolean;
+    updateHistoryStack?: boolean;
 }
-declare const ScrollSpy: ({ children, navContainerRef, parentScrollContainerRef, scrollThrottle, onUpdateCallback, offsetTop, offsetBottom, useDataAttribute, activeClass, useBoxMethod, }: ScrollSpyProps) => JSX.Element;
+declare const ScrollSpy: ({ children, navContainerRef, parentScrollContainerRef, scrollThrottle, onUpdateCallback, offsetTop, offsetBottom, useDataAttribute, activeClass, useBoxMethod, updateHistoryStack, }: ScrollSpyProps) => JSX.Element;
 export default ScrollSpy;