Package Exports
- react-router
- react-router/lib/AsyncUtils
- react-router/lib/IndexLink
- react-router/lib/IndexLink.js
- react-router/lib/IndexRoute
- react-router/lib/Lifecycle
- react-router/lib/Link
- react-router/lib/Navigation
- react-router/lib/PatternUtils
- react-router/lib/PropTypes
- react-router/lib/Redirect
- react-router/lib/Route
- react-router/lib/RouteContext
- react-router/lib/RouteUtils
- react-router/lib/Router
- react-router/lib/RoutingContext
- react-router/lib/State
- react-router/lib/TransitionUtils
- react-router/lib/computeChangedRoutes
- react-router/lib/getComponents
- react-router/lib/getRouteParams
- react-router/lib/isActive
- react-router/lib/matchRoutes
- react-router/lib/useRoutes
- react-router/modules/PropTypes
- react-router/package
- react-router/package.json
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 (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

A complete routing library for React. https://rackt.github.io/react-router
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
Note: the docs and the examples in master refer to the 1.0 Beta and may be incomplete.
Browse the website and the 0.13.3 tag for the information about the latest stable version.
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
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;
There's also a lib/umd
folder containing a UMD version.
bower + who knows what
$ bower install react-router
Find the UMD/global build in lib/umd
, and the library on window.ReactRouter
. Best of luck to you. :)
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 { Router, Route } from 'react-router';
var App = React.createClass({/*...*/});
var About = React.createClass({/*...*/});
// etc.
var 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>
);
}
});
var 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 [overview guide](/doc/00 Guides/0 Overview.md) and [Advanced Usage](/doc/00 Guides/Advanced Usage.md)
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.