Programmatically navigate using react router

React Router v4

With v4 of React Router, there are three approaches that you can take to programmatic routing within components.

Use the withRouter higher-order component. Use composition and render a Use the context. React Router is mostly a wrapper around the history library. history handles interaction with the browser's window.history for you with its browser and hash histories. It also provides a memory history which is useful for environments that don't have a global history. This is particularly useful in mobile app development (react-native) and unit testing with Node.

A history instance has two methods for navigating: push and replace. If you think of the history as an array of visited locations, push will add a new location to the array and replace will replace the current location in the array with the new one. Typically you will want to use the push method when you are navigating.

In earlier versions of React Router, you had to create your own history instance, but in v4 the , , and components will created browser, hash, and memory instances for you. React Router makes the properties and methods of the history instance associated with your router available through the context, under the router object.

  1. Use the withRouter higher-order component The withRouter higher-order component will inject the history object as a prop of the component. This allows you to access the push and replace methods without having to deal with the context.

import { withRouter } from 'react-router-dom' // this also works with react-router-native

const Button = withRouter(({ history }) => ( ))

  1. Use composition and render a The component isn't just for matching locations. You can render a pathless route and it will always match the current location. The component passes the same props as withRouter, so you will be able to access the history methods through the history prop.

import { Route } from 'react-router-dom'

const Button = () => ( ( )} /> )

  1. Use the context* *But you probably should not

The last option is one that you should only use if you feel comfortable working with React's context model. Although context is an option, it should be stressed that context is an unstable API and React has a section Why Not To Use Context in their documentation. So use at your own risk!

const Button = (props, context) => ( )

// you need to specify the context type so that it // is available within the component Button.contextTypes = { history: React.PropTypes.shape({ push: React.PropTypes.func.isRequired }) } 1 and 2 are the simplest choices to implement, so for most use cases they are your best bets.