gb-native-router

GB Native Router

Awesome navigation for your React Native app.

Install

Make sure that you are in your React Native project directory and run:

$ npm install gb-native-router --save

Usage

var Router = require('gb-native-router');

The basics:

// The initial page
var HelloPage = React.createClass({
  render: function() {
    return <Text>Hello world!</Text>;
  }
});

// Your route object should contain at least:
// - The name of the route (which will become the navigation bar title)
// - The component object for the page to render
var firstRoute = {
  name: 'Welcome!',
  component: HelloPage
};

// The Router wrapper
var MyApp = React.createClass({
  render() {
    return (
      <Router firstRoute={firstRoute} />
    )
  }
});

AppRegistry.registerComponent('routerTest', () => MyApp);

Boom. That's it.

From the "Hello world!"-page you can then navigate further to a new component by calling this.props.toRoute(). Let's build upon the HelloPage component in our first example:

var HelloPage = React.createClass({

  nextPage: function() {
    this.props.toRoute({
      name: "A new screen",
      component: HelloPage
    });
  },

  render: function() {
    return (
      <View>
        <TouchableHighlight onPress={this.nextPage} underlayColor="transparent">
          <Text>Next page please!</Text>
        </TouchableHighlight>
      </View>
    );
  }
});

Now, when you click on "Next page please!", it will go to the next page (which in this case is still HelloPage but with a new title). Keep in mind that this.props.toRoute() needs to be called from one of the top-level routes, therefore, if your link is deeply nested within multiple components, you need to make sure that the action "bubbles up" until it reaches the parent route, which in turn calls this.props.toRoute().

Configurations

The <Router \> object used to initialize the navigation can take the following props:

• firstRoute (required): A React class corresponding to the first page of your navigation
• headerStyle: Apply a StyleSheet to the navigation bar. You'll probably want to change the backgroundColor for example.
• titleStyle: Apply a StyleSheet to the navigation bar titles. Useful for changing the font or text color.
• borderBottomWidth: Apply a bottom border to your navbar.
• borderColor: Apply a border color to your bottom border.
• backButtonComponent: By default, the navigation bar will display a simple "Back" text for the back button. To change this, you can specify your own backButton component (like in the Twitter app).
• rightCorner: If you have the same occuring action buttons on the right side of your navigation bar (like the Twitter "Compose"-button), you can specify a component for that view.
• customAction: A special callback prop for your action buttons (this can be handy for triggering a side menu for example). The action gets triggered from your custom leftCorner or rightCorner components by calling this.props.customAction("someActionName") from them. It is then picked up like this: <Router customAction={this.doSomething} />.
• hideNavigationBar: Hide the navigation bar, always

The this.props.toRoute() callback prop takes one parameter (a JavaScript object) which can have the following keys:

• name: The name of your route, which will be shown as the title of the navigation bar unless it is changed.
• component (required): The React class corresponding to the view you want to render.
• leftCorner: Specify a component to render on the left side of the navigation bar (like the "Add people"-button on the first page of the Twitter app)
• rightCorner: Specify a component to render on the right side of the navigation bar
• titleComponent: Specify a component to replace the title. This could for example be your logo (as in the first page of the Instagram app)
• headerStyle: Change the style of your header for the new route. You could for example specify a new backgroundColor and the router will automatically make a nice transition from one color to the other!
• passProps: Takes in an object. Passes each key: value pair to your component as a prop. i.e.
• trans: If set to a truthy value it will make the navbar transparent and move your component content so that it sits behind the nav.
• hideNavigationBar: If set to a truthy value will hide the navigationbar out of view, and move the component so that it is at the top of the screen.
• leftCornerProps: If you set a leftCorner component you can use this property to pass props to that component.
• rightCornerProps: If you set a rightCorner component you can use this property to pass props to that component.
• sceneConfig: Control the animation of the route being switched. Possible values are:
  • Navigator.SceneConfigs.FadeAndroid
  • Navigator.SceneConfigs.FloatFromBottom
  • Navigator.SceneConfigs.FloatFromBottomAndroid
  • Navigator.SceneConfigs.FloatFromLeft
  • Navigator.SceneConfigs.FloatFromRight
  • Navigator.SceneConfigs.HorizontalSwipeJump
  • Navigator.SceneConfigs.PushFromRight
  • Navigator.SceneConfigs.VerticalDownSwipeJump
  • Navigator.SceneConfigs.VerticalUpSwipeJump

The this.props.replaceRoute takes in an object that can contain the same keys as toRoute(). The difference is that instead of adding a route to your stack, it replaces the route that you're on with the new route that you pass it.

• This is useful for login or signup screens. If you don't want your user to be able to navigate back to it, then use replaceRoute() rather than toRoute().

The this.props.resetToRoute takes in an object that can contain the same keys as toRoute(). The difference is that instead of adding a route to your stack, it replaces the route that you're on with the new route that you pass it, and empties the navigation stack as well.

• This is useful for going to an application after a login or signup screens. If you don't want your user to be able to navigate back to it, then use resetToRoute() rather than replaceRoute().

The this.props.setRightProps and this.props.setLeftProps take in an object of props and sends that to your navbar's RightComponent and LeftComponent.

• This allows you to talk directly to your navbar, because previously you could only talk to it when navigating forward or backward.

Events emitted by the router: didFocus, emits route name You can add a listener to a component as such:

  	this.props.routeEmitter.addListener('didFocus', (name) => {
			//Check if name is the current component, and if it is, act on this focus event.
		});

A more advanced example: Twitter app

To see more of the router in action, you can check out the Twitter example app that comes with the package. Just make sure that you first drag all the images from node_modules/react-native-router/twitter-example/images to your project's Images.xcassets

After that, don't forget to rebuild the app in XCode before you launch the simulator. Then test the app by requiring the TwitterApp component:

var TwitterApp = require('./node_modules/react-native-router/twitter-example');

var {
  AppRegistry
} = React;

AppRegistry.registerComponent('routerTest', () => TwitterApp);