React Router Component

Version	Compatibility
> 0.24	React 0.13
> 0.23	React 0.12
0.20 - 0.22.2	React 0.11
< 0.20	React 0.10

React router component allows you to define routes in your React application in a declarative manner, directly as a part of your component hierarchy.

Project Overview

Usage is as simple as just returning a configured router component from your component's render() method:

<Locations>
  <Location path="/" handler={MainPage} />
  <Location path="/users/:username" handler={UserPage} />
  <Location path="/search/*" handler={SearchPage} />
  <Location path={/\/product\/([0-9]*)/} handler={ProductPage} />
</Locations>

Alternatively, if you don't prefer JSX:

Locations(null,
  Location({path: "/", handler: MainPage}),
  Location({path: "/users/:username", handler: UserPage}),
  Location({path: "/search/*", handler: SearchPage}),
  Location({path: /\/product\/([0-9]*)/, handler: ProductPage}))

Having routes defined as a part of your component hierarchy allows to dynamically reconfigure routing based on your application state. For example you can return a different set of allowed locations for anonymous and signed-in users.

React router component can dispatch based on location.pathname or location.hash if browser doesn't support History API (see hash routing).

Furthermore it provides advanced features like support for regex matching, full page server side rendering, multiple routers on the same page, querystring parsing, contextual routers and support for async components.

Its functionality is tested using Saucelabs on all modern browsers (IE >= 9, Chrome >= 27, Firefox >= 25, Safari >= 6 and Mobile Safari on iPhone and iPad >= 6).

Its size is about 3.5kb gzipped.

Installation

React router component is packaged on npm:

% npm install react-router-component

Compatibility

Compatible with React 0.12 and React 0.13. Older versions work with older versions of React, see the commit log.

modulexcite / react-router-component Goto Github PK