Demo and example with Redux

How to use

You have two ways to use redux-router5, depending on how you want to navigate:

  • Using the router5 plugin (named reduxPlugin)

  • Using the redux middleware (named router5Middleware)

In both cases, use the provided reducer (router5Reducer).

Using the router plugin

If you choose to not use the middleware, you need to add reduxPlugin to your router. The plugin simply syncs the router state with redux. To navigate, you will need to invoke router.navigate. If you use React, you can use BaseLink from react-router5.

import { reduxPlugin } from 'redux-router5';
// You need a router instance and a store instance
router.usePlugin(reduxPlugin(store.dispatch));

Using the redux middleware

The redux middleware automatically adds the redux plugin to the provided router instance. It will convert a set of redux actions to routing instructions. The available action creators are:

  • navigateTo(routeName, routeParams = {}, routeOptions = {})

  • cancelTransition()

  • clearErrors()

  • canActivate(routeName, true | false)

  • canDeactivate(routeName, true | false)

import { actions } from 'redux-router5'

Use router5Middleware alongside your other middlewares:

import { createStore, applyMiddleware } from 'redux';
import { router5Middleware } from 'redux-router5';
const createStoreWithMiddleware = applyMiddleware(
router5Middleware(router)
)(createStore)

Reducer

This packages exposes a reducer (router5Reducer) that you can add to your application. It contains four properties:

  • route

  • previousRoute

  • transitionRoute (the current transitioning route)

  • transitionError (the last error which occured)

import { combineReducers } from 'redux'
import { router5Reducer } from 'redux-router5'
const reducers = combineReducers({
router: router5Reducer,
// ...add your other reducers
})

Route node selector

In version 6.0.0, routeNodeSelector has been renamed to createRouteNodeSelector. In order to use it efficiently, you need react-redux >= 4.4.0 to be able to perform per component instance memoization.

createRouteNodeSelector is a selector creator designed to be used on a route node and works with connect higher-order component from react-redux.

If your routes are nested, you'll have a few route nodes in your application. On each route change, not all components need to be re-rendered. createRouteNodeSelector will only output a new state value if the provided node is concerned by a route change.

import { connect } from 'react-redux';
import { createRouteNodeSelector } from 'redux-router5';
import { Home, About, Contact } from './components';
import { startsWithSegment } from 'router5-helpers';
function Root({ route }) {
const { params, name } = route;
const testRoute = startsWithSegment(name);
if (testRoute('home')) {
return <Home params={ params } />;
} else if (testRoute('about')) {
return <About params={ params } />;
} else if (testRoute('contact')) {
return <Contact params={ params } />;
}
return null
}
export default connect(createRouteNodeSelector(''))(Root);

Using createRouteNodeSelector with other connect properties:

export default connect(state => {
const routeNodeSelector = createRouteNodeSelector('');
return (state) => ({
a: state.a,
b: state.b,
...routeNodeSelector(state)
})
)(Root);

With immutable-js

If you are using immutable-js and redux-immutable simply use the reducer from 'redux-router5/immutable/reducer'

import router5Reducer from 'redux-router5/immutable/reducer';