Package Exports

connected-react-router
connected-react-router/lib/actions

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (connected-react-router) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Connected React Router

A Redux binding for React Router v4

Main features

✨ Synchronize router state with redux store with uni-directional flow (history -> store -> router -> components)

🎁 Support React Router v4

☀️ Support functional component hot reloading while preserving state (with react-hot-reload v3)

🎉 Dispatching history methods (push, replace, go, goBack, goForward) are available for both redux-thunk and redux-saga

⛄ Nested children can access routing state such as current location directly with redux's connect

Installation

Using npm:

$ npm install --save connected-react-router

Or yarn:

$ yarn add connected-react-router

Usage

Step 1

Create a history object.
Wrap the root reducer with connectRouter and supply the history object to get a new root reducer.
Use 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 { routerMiddleware, connectRouter } 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 ...
    ),
  ),
)

Step 2

Wrap your react-router v4 routing with ConnectedRouter and pass history object as a prop.
Place ConnectedRouter as children of react-redux's Provider.

import React from 'react'
import ReactDOM from 'react-dom'
import { Provider } from 'react-redux'
import { Match, Miss } 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 */ }
        <Match exactly pattern="/" render={() => (<div>Match</div>)} />
        <Miss render={() => (<div>Miss</div>)} />
      </div>
    </ConnectedRouter>
  </Provider>,
  document.getElementById('react-root')
)

Now, it's ready to work!

Examples

See examples folder

FAQ

How to navigate with Redux action
How to get current URL path
How to support functional component hot reloading

How to navigate with Redux action

with store.dispatch

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

store.dispatch(push('/path/to/somewhere'))

in redux thunk

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

export const login = (username, password) => (dispatch) => {

  /* do something before redirection */

  dispatch(push('/home'))
}

in redux saga

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'))
}

How to get current URL path

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)

How to support functional component hot reloading

Separate main app component to another file.

App.js

import React from 'react'
import { Match, Miss } from 'react-router' /* react-router v4 */
import { ConnectedRouter } from 'connected-react-router'

const App = ({ history }) => ( /* receive history object via props */
  <ConnectedRouter history={history}>
    <div>
      <Match exactly pattern="/" render={() => (<div>Match</div>)} />
      <Miss render={() => (<div>Miss</div>)} />
    </div>
  </ConnectedRouter>
)

export default App

Wrap the 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 renderWithHotReload = (AppComponent) => { // 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')
  )
}

renderWithHotReload(App) // render

Detect change and re-render with hot reload.

index.js

...
if (module.hot) {
  module.hot.accept('./App', () => {
    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!

Build

npm run build

Generated files will be in lib folder.

Cautions

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.

Todos

Add tests

Acknowledge

Connected React Router is based on several awesome people' ideas

Several parts of Connected React Router is based on react-router-redux v4.
A PR by @timdorr to make react-router-redux v5 to integrate React Router v4 contains several ideas to drive Connected React Router.
The ConnectedRouter component is inspired by App component by @cherijs with history synchronization enhancement.
The idea of uni-directional flow (history -> store -> router -> components) is from a @lourd's comment

License

MIT License