Merge pull request #11 from 4Catalyzer/customize-scroll-behavior

Allow customizing creation of scroll behavior

README.md

@@ -63,6 +63,28 @@ const shouldUpdateScrollByRoute = (prevRenderArgs, { routes }) => {
 
   return true;
 };
+
+const render = renderArgs => (
+  <ScrollManager
+    shouldUpdateScroll={shouldUpdateScrollByPathname}
+    renderArgs={renderArgs}
+  >
+    {/* ... */}
+  </ScrollManager>
+);
+```
+
+You can customize `<ScrollManager>` even further by providing a `createScrollBehavior` callback that creates the scroll behavior object. This allows using a custom subclass of `ScrollBehavior` from scroll-behavior with custom logic. When using a custom `createScrollBehavior` callback, you can continue to specify the `shouldUpdateScroll` callback as above.
+
+```js
+const render = renderArgs => (
+  <ScrollManager
+    createScrollBehavior={config => new MyScrollBehavior(config)}
+    renderArgs={renderArgs}
+  >
+    {/* ... */}
+  </ScrollManager>
+);
 ```
 
 [npm-badge]: https://img.shields.io/npm/v/found-scroll.svg

src/ScrollManager.js

@@ -8,21 +8,26 @@ const STORAGE_NAMESPACE = '@@scroll';
 
 const propTypes = {
   shouldUpdateScroll: PropTypes.func,
+  createScrollBehavior: PropTypes.func.isRequired,
   renderArgs: PropTypes.shape({
     location: PropTypes.object.isRequired,
     router: routerShape.isRequired,
   }).isRequired,
   children: PropTypes.element,
 };
 
+const defaultProps = {
+  createScrollBehavior: config => new ScrollBehavior(config),
+};
+
 class ScrollManager extends React.Component {
   constructor(props, context) {
     super(props, context);
 
-    const { renderArgs } = props;
+    const { createScrollBehavior, renderArgs } = props;
     const { router } = renderArgs;
 
-    this.scrollBehavior = new ScrollBehavior({
+    this.scrollBehavior = createScrollBehavior({
       addTransitionHook: router.addTransitionHook,
       stateStorage: new StateStorage(router, STORAGE_NAMESPACE),
       getCurrentLocation: () => this.props.renderArgs.location,
@@ -65,5 +70,6 @@ class ScrollManager extends React.Component {
 }
 
 ScrollManager.propTypes = propTypes;
+ScrollManager.defaultProps = defaultProps;
 
 export default ScrollManager;