fluxapp-router

A router plugin for Fluxapp. Manages the current page state, gives you info about the currently opened page and history, and gracefully degrades on non-historyAPI and non-js browsers.

Installation

npm install --save fluxapp-router

Usage

'use strict';

import fluxApp from 'fluxapp';
import fluxAppRouter from 'fluxapp-router';

fluxApp.registerPlugins({
  router: fluxAppRouter,
});

Router binds to special static methods on components:

willTransitionTo
willTransitionFrom

which enables the components to do some setup at transitions. If false is returned from any of them, the transition will be cancelled.

Actions

Fluxapp router exposes a method on the fluxapp context getRouterActions() but is also available under the namespace router using getActions('router')

go / forward / back

export default React.createClass({
  mixins: [fluxApp.mixins.component],

  statics: {
    willTransitionTo: function() {},
    willTransitionFrom: function() {},
  },

  onBackClick(event) {
    const actions = this.getActions('router');
    const forward = this.state.forward;
    const previous = this.state.previous;
    const options = {};

    if (previous) {
      actions.back();
    } else if (forward) {
      actions.forward();
    } else {
      actions.go('routeid', options);
    }

    event.preventDefault();
  },

})

Components

Link

import Link from 'react-router/components';

<Link to="routerid" meta={customOptions} onClick={customOnCLick} />
<Link to="/route/url" meta={customOptions} onClick={customOnCLick} />

Options

Options provided should be compatible with those used by fluxapps internal router#build method.