Skip to content

STRML/react-router-component

Folders and files

NameName
Last commit message
Last commit date

Latest commit

d75cae4 · Apr 15, 2023
Apr 29, 2017
Dec 30, 2019
Feb 20, 2020
Apr 15, 2023
Dec 30, 2019
Apr 15, 2023
Dec 21, 2014
Dec 30, 2015
Dec 5, 2016
Dec 30, 2019
Jul 6, 2017
Feb 20, 2020
Jan 30, 2014
Dec 30, 2019
Sep 26, 2017
Oct 7, 2015
Apr 15, 2023
Apr 15, 2023

Repository files navigation

React Router Component

TravisCI Build Status

Version Compatibility
>= 0.39.0 React v15,16
>= 0.32.0 React v15
>= 0.27.0 React 0.14
0.24 - 0.26.0 React 0.13
0.23 - 0.26.0 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>

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).

Props can be passed through the router by setting them directly on each <Location>, or to all possible routes via a childProps hash.

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

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

Docs