connected-react-router
Advanced tools
Package description
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.
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>;
};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 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.0.0 requires React v16.4.0 and React Redux v6.0 or later.
A Redux binding for React Router v4
:sparkles: Synchronize router state with redux store through uni-directional flow (i.e. history -> store -> router -> components).
:gift: Support React Router v4.
:sunny: Support 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: Support time traveling in Redux DevTools.
:gem: Support Immutable.js
:muscle: Support TypeScript
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
In your root reducer file,
history as an argument and returns a root reducer.router reducer into root reducer by passing history to connectRouter.router.// reducers.js
import { combineReducers } from 'redux'
import { connectRouter } from 'connected-react-router'
export default (history) => combineReducers({
router: connectRouter(history),
... // rest of your reducers
})
When creating a Redux store,
history object.history to the root reducer creator.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
}
ConnectedRouter and pass the history object as a prop.ConnectedRouter as a child of react-redux's Provider.// index.js
...
import { Provider } from 'react-redux'
import { Route, Switch } from 'react-router' // react-router v4
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 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!
See the examples folder
npm run build
Generated files will be in the lib folder.
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>
)
}
...
See Contributors and Acknowledge.
FAQs
A Redux binding for React Router v4 and v5
We found that connected-react-router demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Researchers recently demonstrated that the npm Registry is vulnerable to cache poisoning combined with DoS, posing significant risks for package availability.
Security News
The June TC39 meeting wrapped up this week with eight proposals moving on to the next stage. Here's a quick roundup of the features that the committee approved to advance.
Security News
Cyber extortion in the US and Canada hit record levels in 2023, with ransomware attacks surging and median ransom demands skyrocketing, though fewer companies are choosing to pay ransoms.