hojberg / react-router

A complete routing solution for React.js

A complete routing library for React

React Router keeps your UI in sync with the URL. It has a simple API with powerful features like lazy code loading, dynamic route matching, and location transition handling built right in. Make the URL your first thought, not an after-thought.

Docs & Help

• Guides and API Docs
• Upgrade Guide
• Changelog
• #react-router channel on reactiflux

Browser Support

We support all browsers and environments where React runs.

Installation

npm + webpack/browserify

$ npm install react-router

Then with a module bundler or webpack, use as you would anything else:

// using an ES6 transpiler, like babel
import { Router, Route, Link } from 'react-router'

// not using an ES6 transpiler
var ReactRouter = require('react-router')
var Router = ReactRouter.Router
var Route = ReactRouter.Route
var Link = ReactRouter.Link

You can require only the pieces you need straight from the lib directory:

import { Router } from 'react-router/lib/Router'

There's also a UMD build in the umd directory:

import ReactRouter from 'react-router/umd/ReactRouter'

If you're using globals, you can find the library on window.ReactRouter.

CDN

If you just want to drop a <script> tag in your page and be done with it, you can use the UMD/global build hosted on cdnjs.

What's it look like?

import React from 'react'
import { Router, Route, Link } from 'react-router'

const App = React.createClass({/*...*/})
const About = React.createClass({/*...*/})
// etc.

const Users = React.createClass({
  render() {
    return (
      <div>
        <h1>Users</h1>
        <div className="master">
          <ul>
            {/* use Link to route around the app */}
            {this.state.users.map(user => (
              <li key={user.id}><Link to={`/user/${user.id}`}>{user.name}</Link></li>
            ))}
          </ul>
        </div>
        <div className="detail">
          {this.props.children}
        </div>
      </div>
    )
  }
})

const User = React.createClass({
  componentDidMount() {
    this.setState({
      // route components are rendered with useful information, like URL params
      user: findUserById(this.props.params.userId)
    })
  },

  render() {
    return (
      <div>
        <h2>{this.state.user.name}</h2>
        {/* etc. */}
      </div>
    )
  }
})

// Declarative route configuration (could also load this config lazily
// instead, all you really need is a single root route, you don't need to
// colocate the entire config).
React.render((
  <Router>
    <Route path="/" component={App}>
      <Route path="about" component={About}/>
      <Route path="users" component={Users}>
        <Route path="/user/:userId" component={User}/>
      </Route>
      <Route path="*" component={NoMatch}/>
    </Route>
  </Router>
), document.body)

See more in the Introduction and Advanced Usage.

Thanks

React Router was initially inspired by Ember's fantastic router. Many thanks to the Ember team.

Also, thanks to BrowserStack for providing the infrastructure that allows us to run our build in real browsers.