rlog76 / react-router-rails

react-router-rails

React Router for Rails asset pipeline

• React Router version: 0.11.6

Installation

1. Add to your Gemfile and install with bundler:

gem 'react-router-rails', '~>0.11.6.1'

bundle install

2. Require the modified React-Router javascript file in app/assets/javascripts/application.js:

//= require react_router
// OR
//= require react_router.min

Or in app/assets/javascripts/application.js.coffee:

#= require react_router
#OR
#= require react_router.min

#Optional. Gives you the ability to use the view helper in your template
#= require react_router_ujs

3. Using the view helper:

Define your routes 'MyRoutes' in any javascript file like you would normally do:

var Route = ReactRouter.Route

this.MyRoutes = (
  <Route handler={App}>
    <Route name='home' handler={Home} path='/' />
    ...
  </Route>
)

In the view helper set the name of your routes component

<%= react_router 'MyRoutes' %>

Optionally set the location handler (defaults to HashLocation):

<%= react_router 'MyRoutes', 'HistoryLocation' %>

4. Using React Router in your javascript :

ReactRouter.run(routes, function (Handler) {
  React.render(<Handler/>, document.body);
});

Or in coffeescript:

ReactRouter.run(routes, (Handler) ->
  React.render <Handler/>, document.body
)

Roadmap

1. Better handle of production version

Instead of explicit require minified version, we should make it possible to configure that in the environment config files like the react-rails configuration (ex. config.react_router_variant = :production)

2. Serverside rendering

Use the ReactRouter.run + React.renderToString method to render the markup on the server.

Acknowledgements

This gem is highly inspired and based on React Rails code. Thanks!

React Router by Ryan Florence, Michael Jackson licensed under the MIT license

Copyright Mario Peixoto, released under the MIT license.