connected-react-router

What is connected-react-router?

connected-react-router is a library that integrates React Router with Redux, allowing you to keep your router state in sync with your Redux store. This can be particularly useful for applications that require complex state management and routing logic.

What are connected-react-router's main functionalities?

Synchronize Router State with Redux

This code demonstrates how to set up a Redux store that is synchronized with React Router. It uses `createBrowserHistory` to create a history object, `routerMiddleware` to intercept navigation actions, and `connectRouter` to create a reducer that keeps the router state in sync with the Redux store. The `ConnectedRouter` component is then used to render the router, ensuring that the router state is managed by Redux.

import { createBrowserHistory } from 'history';
import { applyMiddleware, createStore } from 'redux';
import { routerMiddleware } from 'connected-react-router';
import { connectRouter } from 'connected-react-router';
import { Provider } from 'react-redux';
import { ConnectedRouter } from 'connected-react-router';
import { Route, Switch } from 'react-router';
import React from 'react';
import ReactDOM from 'react-dom';

const history = createBrowserHistory();
const store = createStore(
  connectRouter(history)(rootReducer),
  applyMiddleware(routerMiddleware(history))
);

ReactDOM.render(
  <Provider store={store}>
    <ConnectedRouter history={history}>
      <Switch>
        <Route exact path="/" component={Home} />
        <Route path="/about" component={About} />
      </Switch>
    </ConnectedRouter>
  </Provider>,
  document.getElementById('root')
);

Dispatch Navigation Actions

This code demonstrates how to dispatch navigation actions using the `push` function from `connected-react-router`. This allows you to programmatically navigate to different routes within your application by dispatching actions to the Redux store.

import { push } from 'connected-react-router';

// Dispatch a navigation action
store.dispatch(push('/about'));

Access Router State in Redux

This code demonstrates how to access the router state from within a React component using the `useSelector` hook from `react-redux`. This allows you to read the current location and other router state properties directly from the Redux store.

import { useSelector } from 'react-redux';

const MyComponent = () => {
  const location = useSelector(state => state.router.location);
  return <div>Current Path: {location.pathname}</div>;
};

Other packages similar to connected-react-router

react-router-redux

react-router-redux is another library that aims to keep React Router and Redux in sync. However, it is no longer actively maintained and has been deprecated in favor of connected-react-router. It provides similar functionality but lacks the ongoing support and updates.

redux-first-router

redux-first-router is a library that takes a different approach by making routing a first-class citizen in Redux. It allows you to define routes as part of your Redux actions and reducers, providing a more integrated approach to routing and state management. It offers more control over routing logic but can be more complex to set up compared to connected-react-router.

README

Breaking change in v5.0.0! Please read How to migrate from v4 to v5/v6.

v6.0.0 requires React v16.4.0 and React Redux v6.0 / v7.0.

Connected React Router

A Redux binding for React Router v4 and v5

Main features

:sparkles: Synchronize router state with redux store through uni-directional flow (i.e. history -> store -> router -> components).

:gift: Supports React Router v4 and v5.

:sunny: Supports functional component hot reloading while preserving state (with react-hot-reload).

:tada: Dispatching of history methods (push, replace, go, goBack, goForward) works for both redux-thunk and redux-saga.

:snowman: Nested children can access routing state such as the current location directly with react-redux's connect.

:clock9: Supports time traveling in Redux DevTools.

:gem: Supports Immutable.js

:muscle: Supports TypeScript

Installation

Connected React Router requires React 16.4 and React Redux 6.0 or later.

$ npm install --save connected-react-router

Or

$ yarn add connected-react-router

Usage

Step 1

In your root reducer file,

• Create a function that takes history as an argument and returns a root reducer.
• Add router reducer into root reducer by passing history to connectRouter.
• Note: The key MUST be router.

// reducers.js
import { combineReducers } from 'redux'
import { connectRouter } from 'connected-react-router'

const createRootReducer = (history) => combineReducers({
  router: connectRouter(history),
  ... // rest of your reducers
})
export default createRootReducer

Step 2

When creating a Redux store,

• Create a history object.
• Provide the created history to the root reducer creator.
• Use routerMiddleware(history) if you want to dispatch history actions (e.g. to change URL with push('/path/to/somewhere')).

// configureStore.js
...
import { createBrowserHistory } from 'history'
import { applyMiddleware, compose, createStore } from 'redux'
import { routerMiddleware } from 'connected-react-router'
import createRootReducer from './reducers'
...
export const history = createBrowserHistory()

export default function configureStore(preloadedState) {
  const store = createStore(
    createRootReducer(history), // root reducer with router state
    preloadedState,
    compose(
      applyMiddleware(
        routerMiddleware(history), // for dispatching history actions
        // ... other middlewares ...
      ),
    ),
  )

  return store
}

Step 3

• Wrap your react-router v4/v5 routing with ConnectedRouter and pass the history object as a prop. Remember to delete any usage of BrowserRouter or NativeRouter as leaving this in will cause problems synchronising the state.
• Place ConnectedRouter as a child of react-redux's Provider.
• N.B. If doing server-side rendering, you should still use the StaticRouter from react-router on the server.

// index.js
...
import { Provider } from 'react-redux'
import { Route, Switch } from 'react-router' // react-router v4/v5
import { ConnectedRouter } from 'connected-react-router'
import configureStore, { history } from './configureStore'
...
const store = configureStore(/* provide initial state if any */)

ReactDOM.render(
  <Provider store={store}>
    <ConnectedRouter history={history}> { /* place ConnectedRouter under Provider */ }
      <> { /* your usual react-router v4/v5 routing */ }
        <Switch>
          <Route exact path="/" render={() => (<div>Match</div>)} />
          <Route render={() => (<div>Miss</div>)} />
        </Switch>
      </>
    </ConnectedRouter>
  </Provider>,
  document.getElementById('react-root')
)

Note: the history object provided to router reducer, routerMiddleware, and ConnectedRouter component must be the same history object.

Now, it's ready to work!

Examples

See the examples folder

FAQ

• How to navigate with Redux action
• How to get the current browser location (URL)
• How to set Router props e.g. basename, initialEntries, etc.
• How to hot reload functional components
• How to hot reload reducers
• How to support Immutable.js
• How to implement server-side rendering (sample codebase)
• How to migrate from v4 to v5
• How to use connected-react-router with react native
• How to use your own context with react-redux

Build

npm run build

Generated files will be in the lib folder.

Development

When testing the example apps with npm link or yarn link, you should explicitly provide the same Context to both Provider and ConnectedRouter to make sure that the ConnectedRouter doesn't pick up a different ReactReduxContext from a different node_modules folder.

In index.js.

...
import { Provider, ReactReduxContext } from 'react-redux'
...
      <Provider store={store} context={ReactReduxContext}>
        <App history={history} context={ReactReduxContext} />
      </Provider>
...

In App.js,

...
const App = ({ history, context }) => {
  return (
    <ConnectedRouter history={history} context={context}>
      { routes }
    </ConnectedRouter>
  )
}
...

Contributors

See Contributors and Acknowledge.

License

MIT License