Repository files navigation

This project is no longer maintained. For your Redux <-> Router syncing needs with React Router 4+, please see one of these libraries instead:

• connected-react-router

⚠️This repo is for react-router-redux 4.x, which is only compatible with react-router 2.x and 3.x

Keep your router in sync with application state ✨

Formerly known as redux-simple-router

You're a smart person. You useRedux to manage your application state. You useReact Router to do routing. All is good.

But the two libraries don't coordinate. You want to do time travel with your application state, but React Router doesn't navigate between pages when you replay actions. It controls an important part of application state: the URL.

This library helps you keep that bit of state in sync with your Redux store. We keep a copy of the current location hidden in state. When you rewind your application state with a tool likeRedux DevTools, that state change is propagated to React Router so it can adjust the component tree accordingly. You can jump around in state, rewinding, replaying, and resetting as much as you'd like, and this library will ensure the two stay in sync at all times.

This library is notnecessary for using Redux together with React Router. You can use the two together just fine without any additional libraries. It is useful if you care about recording, persisting, and replaying user actions, using time travel. If you don't care about these features, justuse Redux and React Router directly.

npm install --save react-router-redux

This library allows you to use React Router's APIs as they are documented. And, you can use redux like you normally would, with a single app state. The library simply enhances a history instance to allow it to synchronize any changes it receives into application state.

history +store (redux) →react-router-redux → enhancedhistory →react-router

Let's take a look at a simple example.

importReactfrom'react'importReactDOMfrom'react-dom'import{createStore,combineReducers}from'redux'import{Provider}from'react-redux'import{Router,Route,browserHistory}from'react-router'import{syncHistoryWithStore,routerReducer}from'react-router-redux'importreducersfrom'<project-path>/reducers'// Add the reducer to your store on the `routing` keyconststore=createStore(combineReducers({    ...reducers,routing:routerReducer}))// Create an enhanced history that syncs navigation events with the storeconsthistory=syncHistoryWithStore(browserHistory,store)ReactDOM.render(<Providerstore={store}>{/* Tell the Router to use our enhanced history */}<Routerhistory={history}><Routepath="/"component={App}><Routepath="foo"component={Foo}/><Routepath="bar"component={Bar}/></Route></Router></Provider>,document.getElementById('mount'))

Now any time you navigate, which can come from pressing browser buttons or navigating in your application code, the enhanced history will first pass the new location through the Redux store and then on to React Router to update the component tree. If you time travel, it will also pass the new state to React Router to update the component tree again.

Simply listen to the enhanced history viahistory.listen. This takes in a function that will receive alocation any time the store updates. This includes any time travel activity performed on the store.

consthistory=syncHistoryWithStore(browserHistory,store)history.listen(location=>analyticsService.track(location.pathname))

For other kinds of events in your system, you can use middleware on your Redux store like normal to watch any action that is dispatched to the store.

When using a wrapper for your store's state, such as Immutable.js, you will need to change two things from the standard setup:

1. By default, the library expects to find the history state atstate.routing. If your wrapper prevents accessing properties directly, or you want to put the routing state elsewhere, pass a selector function to access the historystate via theselectLocationState option onsyncHistoryWithStore.
2. Provide your own reducer function that will receive actions of typeLOCATION_CHANGE and return the payload merged into thelocationBeforeTransitions property of the routing state. For example,state.set("routing", {locationBeforeTransitions: action.payload}).

These two hooks will allow you to store the state that this library uses in whatever format or wrapper you would like.

React Routerprovides route information via a route component's props. This makes it easy to access them from a container component. When usingreact-redux toconnect() your components to state, you can access the router's props from the2nd argument ofmapStateToProps:

functionmapStateToProps(state,ownProps){return{id:ownProps.params.id,filter:ownProps.location.query.filter};}

You should not read the location state directly from the Redux store. This is because React Router operates asynchronously (to handle things such as dynamically-loaded components) and your component tree may not yet be updated in sync with your Redux state. You should rely on the props passed by React Router, as they are only updated after it has processed all asynchronous code.

React Router provides singleton versions of history (browserHistory andhashHistory) that you can import and use from anywhere in your application. However, if you prefer Redux style actions, the library also provides a set of action creators and a middleware to capture them and redirect them to your history instance.

import{createStore,combineReducers,applyMiddleware}from'redux';import{routerMiddleware,push}from'react-router-redux'// Apply the middleware to the storeconstmiddleware=routerMiddleware(browserHistory)conststore=createStore(reducers,applyMiddleware(middleware))// Dispatch from anywhere like normal.store.dispatch(push('/foo'))

• examples/basic - basic reference implementation

Examples from the community:

• react-redux-styled-hot-universal (SSR, Universal Webpack, Redux, React-router, Webpack 2, Babel, Styled Components and more...)
• shakacode/react-webpack-rails-tutorial - react-router-redux includingServer Rendering usingReact on Rails, live atwww.reactrails.com.
• davezuko/react-redux-starter-kit - popular redux starter kit
  • tip: migrating from react-router-redux^3.0.0? usethis commit as a reference
• svrcekmichal/universal-react - Universal react app with async actions provided bysvrcekmichal/reasync package
• steveniseki/react-router-redux-example - minimal react-router-redux example includes css modules and universal rendering
• choonkending/react-webpack-node - Full-stack universal Redux App
• kuy/treemap-with-router - An example for react-router-redux with d3's treemap.

→Have an example to add? Send us a PR! ←

You must add this reducer to your store for syncing to work.

A reducer function that stores location updates fromhistory. If you usecombineReducers, it should be nested under therouting key.

Creates an enhanced history from the provided history. This history changeshistory.listen to pass all location updates through the provided store first. This ensures if the store is updated either from a navigation event or from a time travel action, such as a replay, the listeners of the enhanced history will stay in sync.

You must provide the enhanced history to your<Router> component. This ensures your routes stay in sync with your location and your store at the same time.

Theoptions object takes in the following optional keys:

• selectLocationState - (defaultstate => state.routing) A selector function to obtain the history state from your store. Useful when not using the providedrouterReducer to store history state. Allows you to use wrappers, such as Immutable.js.
• adjustUrlOnReplay - (defaulttrue) Whenfalse, the URL will not be kept in sync during time travel. This is useful when usingpersistState from Redux DevTools and not wanting to maintain the URL state when restoring state.

You must installrouterMiddleware for these action creators to work.

Action creators that correspond with thehistory methods of the same name. For reference they are defined as follows:

• push - Pushes a new location to history, becoming the current location.
• replace - Replaces the current location in history.
• go - Moves backwards or forwards a relative number of locations in history.
• goForward - Moves forward one location. Equivalent togo(1)
• goBack - Moves backwards one location. Equivalent togo(-1)

Bothpush andreplace take in alocation descriptor, which can be an object describing the URL or a plain string URL.

These action creators are also available in one single object asrouterActions, which can be used as a convenience when using Redux'sbindActionCreators().

A middleware you can apply to your Reduxstore to capture dispatched actions created by the action creators. It will redirect those actions to the providedhistory instance.

An action type that you can listen for in your reducers to be notified of route updates. Firesafter any changes to history.