syug / react-router Goto Github PK

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.

Important: This is the master branch of React Router and may contain changes that are not yet released. To see the code for the most recently published release, browse the latest tag.

• Tutorial - Do This First!
• Guides and API Docs (latest release)
• Change Log
• Stack Overflow
• Codepen Boilerplate Please use for bug reports

Note: If you are still using React Router 0.13.x the docs can be found on the 0.13.x branch. Upgrade information is available on the change log.

For questions and support, please visit our channel on Reactiflux or Stack Overflow. The issue tracker is exclusively for bug reports and feature requests.

We support all browsers and environments where React runs.

Using npm:

$ npm install --save react-router

Then with a module bundler like webpack that supports either CommonJS or ES2015 modules, 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 Router = require('react-router').Router
var Route = require('react-router').Route
var Link = require('react-router').Link

The UMD build is also available on npmcdn:

<script src="https://npmcdn.com/react-router/umd/ReactRouter.min.js"></script>

You can find the library on window.ReactRouter.

React Router follows semver to the best of our interpretation of it. We want React Router to be a stable dependency that’s easy to keep current. Here is our upgrading strategy for your apps.

Assuming we are currently on version 1.0:

1. 2.0 is fully backward compatible with 1.0 so you can upgrade, and then update your code incrementally.
2. All deprecated 1.0 API usage warns to the console and links to an upgrade guide.
3. 3.0 will remove 1.0 deprecations completely.
4. 3.0 will be released no sooner than three months after 2.0. This gives an API, in the worst case scenario, six months of life if you’re staying perfectly up-to-date.
5. Some codemods that will automatically update your code will be available at rackt/rackt-codemod

If it’s fully backwards compatible, why isn’t that a minor release?

If we didn’t provide the backwards compatibility then you wouldn’t be asking this question — but then upgrading would break your app. We don’t want to break your app, we want smooth, incremental upgrades.

In practice, this means you can:

1. Upgrade from 1.0 to 2.0 and your app will still run.
2. Update your code incrementally to the new API, and you have three months before the next release to do it.
3. Run the codemods to make some of (2) automatic.
4. If your code runs without warnings, you can repeat this list with version 3.0

import React from 'react'
import { render } from 'react-dom'
import { Router, Route, Link, browserHistory } 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).
render((
  <Router history={browserHistory}>
    <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, Advanced Usage, and Examples.

Thanks to our sponsors for supporting the development of React Router.

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.