react-component-router

Official ComponentRouter bindings for React.

Installation

NPM

npm install --save react redux history qs component-router react-component-router

Don't forget to manually install peer dependencies (react, redux, history, qs, component-router) if you use npm@3.

1998 Script Tag:

<script src="https://unpkg.com/[email protected]/umd/react.production.min.js"></script>
<script src="https://unpkg.com/redux/dist/redux.min.js"></script>
<script src="https://unpkg.com/qs/dist/qs.js"></script>
<script src="https://unpkg.com/history/umd/history.min.js"></script>
<script src="https://unpkg.com/component-router/build/component-router.min.js"></script>
<script src="https://unpkg.com/react-component-router/build/react-component-router.min.js"></script>
(Module exposed as `ReactComponentRouter`)

Demo

// TODO

Codepen demo

// TODO

Usage

See example/App/index.js

Options

// TODO

Development and testing

Currently is being developed and tested with the latest stable Node 8 on OSX.

To run example covering all ReactComponentRouter features, use yarn start, which will compile example/index.js

git clone [email protected]:in-flux/react-component-router.git
cd react-component-router
yarn install
yarn start

# then
open http://localhost:8080

Tests

# to run ESLint check
yarn lint

# to run tests
yarn test

# to run end-to-end tests
# first, run `selenium/standalone-firefox:3.4.0` docker image
docker run -p 4444:4444 selenium/standalone-firefox:3.4.0
# then run test
yarn e2e

License

MIT