flux-react-router

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

flux-react-router

★ 13 Open GitHub ↗

A router in the flux-react family

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![Build Status](https://travis-ci.org/christianalfoni/flux-react-router.svg?branch=master)](https://travis-ci.org/christianalfoni/flux-react-router)

## React Router

Part of [flux-react](https://github.com/christianalfoni/flux-react), the router is a simple HTML5 router that will cover most your needs. Read more about FLUX over at [Facebook Flux](http://facebook.github.io/flux/).

Download from **dist**: [ReactRouter.min.js](https://rawgithub.com/christianalfoni/flux-react-router/master/dist/ReactRouter.min.js) or install from npm with `npm install flux-react-router`.

### Scope
- Is a function that takes a hash of routes pointing to callbacks
- Alternatively a route can point to another route for redirect
- Go to a route directly with: Routes.goTo(path)
- Return route goTo function with: Routes.deferTo(path), see example

### Example
```javascript
var React = require('react');
var ReactRouter = require('flux-react-router');
var App = require('./App.js');
var Posts = require('./Posts.js');
var Post = require('./Post.js');

ReactRouter.createRoute('/', function () {
	React.render(<App/>, document.body);
});

ReactRouter.createRoute('/posts', function () {
	React.render(<Posts/>, document.body);	
});

ReactRouter.createRoute('/posts/{id}', function () {
	React.render(<Post id={params.id}/>, document.body);	
});

ReactRouter.createRoute('*', '/');

ReactRouter.init();
// or
SomePromise().then(ReactRouter.init);

/* In other parts of your code */

// Go directly to new route
ReactRouter.goTo('/');

// deferTo() returns a function, so that on click it will trigger the route
<button onClick={Router.deferTo('/')}>Go</button>

```

## Contribute

### Develop
* Run `npm install`
* Run `gulp`
* Any changes to files in `app/` will be compiled to `dev/`

### Test
* Run `gulp test -'./tests/Route-test.js'
* Open the `test.html` file in your browser
* Any changes to files in `app/` and the test file will autoreload the browser

### Run test in terminal
* Run `npm test`
* Currently uses phantomJS, though you can use chrome

flux-react-router

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README