Add "omitRouter" option (#421)

* Add "omitRouter" option
supasate · Sep 12, 2020 · f10b162 · f10b162
1 parent afb7ee6
commit f10b162
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -18,6 +18,7 @@ declare module 'connected-react-router' {
     history: History<S>;
     context?: React.Context<ReactReduxContextValue>;
     noInitialPop?: boolean;
+    omitRouter?: boolean;
   }
 
   export type RouterActionType = Action;

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "connected-react-router",
-  "version": "6.8.0",
+  "version": "6.8.1",
   "description": "A Redux binding for React Router v4 and v5",
   "main": "lib/index.js",
   "module": "esm/index.js",

diff --git a/src/ConnectedRouter.js b/src/ConnectedRouter.js
@@ -85,7 +85,15 @@ const createConnectedRouter = (structure) => {
     }
 
     render() {
-      const { history, children } = this.props
+      const { omitRouter, history, children } = this.props
+
+      // The `omitRouter` option is available for applications that must
+      // have a Router instance higher in the component tree but still desire
+      // to use connected-react-router for its Redux integration.
+
+      if (omitRouter) {
+        return <>{ children }</>
+      }
 
       return (
         <Router history={history}>
@@ -111,6 +119,7 @@ const createConnectedRouter = (structure) => {
     onLocationChanged: PropTypes.func.isRequired,
     noInitialPop: PropTypes.bool,
     stateCompareFunction: PropTypes.func,
+    omitRouter: PropTypes.bool,
   }
 
   const mapDispatchToProps = dispatch => ({