Navigator-redux NPM

What is this?

Few days ago I started this project as a spin-off from navigator-rfc. This repo is an implementation of the super-simple navigator behavior (without animated transitions! Please, keep it in mind).

Motivation

To make a proof of concept for react-native navigator (based on navigator-rfc), driven by redux.

Getting started

First of all, check an example I've made. In index.ios.js you'll find the most important parts.

Installation

As usual:

$ npm i navigator-redux --save

Then include it in your code:

import {NavigatorRedux, makeNavState, navigationReducer} from 'navigator-redux';

And finally, use it to make your navigation to work:

const store = createStore(
  navigationReducer,
  makeNavState([{title:'Initial Route', component: YourComponent}])
);

AppRegistry.registerComponent('Basic', () => () => (
  <Provider store={store}>
    <NavigatorRedux />
  </Provider>
));

API

Each view in the stack, while rendered, will receive a nav property with index, stack and actions.

index {Number}. Used to track your navigation stack position
stack {Immutable.Stack}. Your navigation stack
actions {Object}: {title: 'Route Title', component: Component, [passProps: {text: 'Props'}]} passProps is optional
- push(Object). Push a new route to navigation state
- pop(). Jump back to the previous navigation state
- replace(Object). Replace a current navigation route by a given one

For further reading, check an example.