react-router
    Overview
    Documentation
    Insights
    Code
    Contributors
    Dependencies
    Alternatives

react-router

Declarative routing for React

5.0.1  •  Published 4 months ago  •  by ReactTraining  •  MIT License

React Router Travis npm package

React Router is 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.

Codecov Discord

4.0 is here!

The next version of React Router (4.0) has been released! Check out the master branch.

4.0 Documentation

Docs & Help

Older Versions:

For questions and support, please visit our channel on Reactiflux or Stack Overflow.

Browser Support

We support all browsers and environments where React runs.

Installation

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 unpkg:

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

You can find the library on window.ReactRouter.

What’s it look like?

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({/*...*/})
const NoMatch = React.createClass({/*...*/})

const Users = React.createClass({
  render() {
    return (
      <div>
        <h2>Users</h2>
        <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.getElementById('root'))

See more in the Introduction, Guides, and Examples.

Versioning and Stability

We want React Router to be a stable dependency that’s easy to keep current. We take the same approach to versioning as React.js itself: React Versioning Scheme.

Thanks

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.

We are hiring frontend and backend developers!
Come and help us build the ultimate open source directory 🔥

Popularity

Weekly Downloads
2.3M
Stars
37.1K

Maintenance

Development

Last ver 4 months ago
Created 6 years ago
Last commit 3 months ago
1 day between commits

Technology

Node version: 12.4.0
185.9K unpacked

Legal and Compliance

MIT License
OSI Approved
0 vulnerabilities

Contributors

250 contributors
Michael Jackson
Maintainer, 421 commits, 150 merges, 20 PRs
Works at ReactTraining
Tim Dorr
Maintainer, 111 commits, 115 merges, 27 PRs
Works at SalesLoft
Ryan Florence
Maintainer, 97 commits, 115 merges, 25 PRs
Works at reach
taion
125 merges, 178 PRs
Paul Sherman
Maintainer, 76 commits
Mateusz Zatorski
1 commits, 75 merges, 10 PRs

Tags

react
router
route
routing
history
link
© 2019 Devstore, Inc.
Devstore helps developers find and use open-source packages, so they can focus on building amazing things