Security News
NIST Misses 2024 Deadline to Clear NVD Backlog
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
connected-react-router
Advanced tools
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.
A Redux binding for React Router v4
:sparkles: Synchronize router state with redux store with uni-directional flow (history -> store -> router -> components).
:gift: Support React Router v4.
:sunny: Support functional component hot reloading while preserving state (with react-hot-reload v3).
:tada: Dispatching history methods (push
, replace
, go
, goBack
, goForward
) work for both redux-thunk and redux-saga.
:snowman: Nested children can access routing state such as current location directly with react-redux
's connect
.
:clock9: Support time traveling in Redux DevTools.
:gem: Support Immutable.js
Note:
connected-react-router@4.0.0-beta
supports newreact-router@4.0.0-beta
(with<Route>
and<Switch>
)- For old
react-router@4.0.0-alpha
(with<Match>
and<Miss>
), you needconnected-react-router@2.0.0-alpha.5
Using npm:
$ npm install --save connected-react-router
Or yarn:
$ yarn add connected-react-router
history
object.connectRouter
and supply the history
object to get a new root reducer.routerMiddleware(history)
if you want to dispatch history actions (ex. to change URL with push('/path/to/somewhere')
)....
import { createBrowserHistory } from 'history'
import { applyMiddleware, compose, createStore } from 'redux'
import { connectRouter, routerMiddleware } from 'connected-react-router'
...
const history = createBrowserHistory()
const store = createStore(
connectRouter(history)(rootReducer), // new root reducer with router state
initialState,
compose(
applyMiddleware(
routerMiddleware(history), // for dispatching history actions
// ... other middlewares ...
),
),
)
ConnectedRouter
and pass history
object as a prop.ConnectedRouter
as children of react-redux
's Provider
....
import { Provider } from 'react-redux'
import { Route, Switch } from 'react-router' // react-router v4
import { ConnectedRouter } from 'connected-react-router'
...
ReactDOM.render(
<Provider store={store}>
<ConnectedRouter history={history}> { /* place ConnectedRouter under Provider */ }
<div> { /* your usual react-router v4 routing */ }
<Switch>
<Route exact path="/" render={() => (<div>Match</div>)} />
<Route render={() => (<div>Miss</div>)} />
</Switch>
</div>
</ConnectedRouter>
</Provider>,
document.getElementById('react-root')
)
Now, it's ready to work!
See examples folder
import { push } from 'connected-react-router'
store.dispatch(push('/path/to/somewhere'))
import { push } from 'connected-react-router'
export const login = (username, password) => (dispatch) => {
/* do something before redirection */
dispatch(push('/home'))
}
import { push } from 'connected-react-router'
import { put, call } from 'redux-saga/effects'
export function* login(username, password) {
/* do something before redirection */
yield put(push('/home'))
}
The current URL path can be accessed directry from the router state with react-redux
's connect
.
import { connect } from 'react-redux'
const Child = ({ path }) => (
<div>
Child receives path {path}.
</div>
)
const mapStateToProps = state => ({
path: state.router.location.pathname,
})
export default connect(mapStateToProps)(Child)
App.js
import React from 'react'
import { Route, Switch } from 'react-router' /* react-router v4 */
import { ConnectedRouter } from 'connected-react-router'
const App = ({ history }) => ( /* receive history object via props */
<ConnectedRouter history={history}>
<div>
<Switch>
<Route exact path="/" render={() => (<div>Match</div>)} />
<Route render={() => (<div>Miss</div>)} />
</Switch>
</div>
</ConnectedRouter>
)
export default App
App
component with AppContainer
from react-hot-loader
v3 as a top-level container.index.js
import React from 'react'
import ReactDOM from 'react-dom'
import { Provider } from 'react-redux'
import { AppContainer } from 'react-hot-loader' /* react-hot-loader v3 */
import App from './App'
...
const render = () => { // this function will be reused
ReactDOM.render(
<AppContainer> { /* AppContainer for hot reloading v3 */ }
<Provider store={store}>
<AppComponent history={history} /> { /* pass history object as props */ }
</Provider>
</AppContainer>,
document.getElementById('react-root')
)
}
render()
index.js
...
if (module.hot) {
module.hot.accept('./App', () => {
/* For Webpack 2.x
Need to disable babel ES2015 modules transformation in .babelrc
presets: [
["es2015", { "modules": false }]
]
*/
render()
/* For Webpack 1.x
const NextApp = require('./App').default
renderWithHotReload(NextApp)
*/
})
}
Now, when you change any component that App
depends on, it will trigger hot reloading without losing redux state. Thanks react-hot-loader v3!
Detect change and replace with a new root reducer with router state
index.js
...
if (module.hot) {
module.hot.accept('./reducers', () => {
/* For Webpack 2.x
Need to disable babel ES2015 modules transformation in .babelrc
presets: [
["es2015", { "modules": false }]
]
*/
store.replaceReducer(connectRouter(history)(rootReducer))
/* For Webpack 1.x
const nextRootReducer = require('./reducers').default
store.replaceReducer(connectRouter(history)(nextRootReducer))
*/
})
}
combineReducers
from redux-immutable
to create the root reducer.import { combineReducers } from 'redux-immutable'
...
const rootReducer = combineReducers({
...
})
...
ConnectedRouter
, routerMiddleware
, and connectRouter
from connected-react-router/immutable
instead of connected-react-router
.import { ConnectedRouter, routerMiddleware, connectRouter } from 'connected-react-router/immutable'
Immutabel.Map()
import Immutable from 'immutable'
...
const initialState = Immutable.Map()
...
const store = createStore(
connectRouter(history)(rootReducer),
initialState,
...
)
npm run build
Generated files will be in lib
folder.
This is still an experimental project. It relies on several alpha and beta things (i.e. react-hot-loader v3 and react-router v4). Anything can be changed. Bugs are certainly waiting for you to wake them up. Please use it at your own risk.
See Contributors and Acknowledge.
FAQs
A Redux binding for React Router v4 and v5
The npm package connected-react-router receives a total of 335,814 weekly downloads. As such, connected-react-router popularity was classified as popular.
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
NIST has failed to meet its self-imposed deadline of clearing the NVD's backlog by the end of the fiscal year. Meanwhile, CVE's awaiting analysis have increased by 33% since June.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.