node package manager

react-native-starter

---------- # React Native Starter Kit


React Native Starter Kit

Routing + Sidemenu + Flux + Images and HTTP Cache

A package that brings the basic functionality needed to build a React Native application. It helps you with the routing of your applications, a simple way to build a sidemenu, manages your state with flux and gives you a super easy way to cache images and data. # Contents

What is inclueded

  • Routing
    • A simple class to move around your application, you just have to register your view Object and you are good to go.
  • Sidemenu
    • Simplified Drawer to be used as a sidemenu in all your applications.
  • Flux
    • React Native Starter Kit comes with Flux implemented, to create your stores you only need to extend from our BaseStore and make all the actions you need.
  • Cache
    • I know how necessary it is for an application to use local cache and avoid multiple REST requests or to download images and store them locally to boost performance. So I built a really easy to use CacheService to help you out.

Routing

Its really easy to use the routing system, you need to use Navigator component from react native and make a mapper object to register your routes:

import React, { Component } from 'react';
import {AppRegistry, Navigator} from 'react-native';
import {Router} from 'react-native-starter';

import LoginView from './views/LoginView'; import HomeView from './views/HomeView'; const mapper = [ {name: 'index', component: LoginView}, {name: 'home', component: HomeView}, ];

class FirstReactApp extends Component {
  constructor(props){
super(props);
Router.register(mapper);
  }

  render() {
    return (
      <Navigator
        initialRoute={Router.index()}
        renderScene={this.renderSceneNavigator.bind(this)}
      />
    );
  }


  renderSceneNavigator(route, nav)
  {
    Router.setNavigator(nav);
    const Component = route.component;
    return(
          <Component _params={route._params} />
    );
  }
}

AppRegistry.registerComponent('ReactTest', () => FirstReactApp);

Note that we are passing a prop to the component called _params, that is the way you pass information from one view to the other, it will be explained later.

Methods

static register(MapperArray) Call this function on the constructor of your index file, it is an array of objects containing your routes. Each object must have two key: 'name' and 'component'

params:

  • Array:
    • Object:
      • name: Name you will use when you want to move to this view, there is only one reserved name and it is 'index', the view registerd as 'index' will be your initial view.
      • component: React Native Component to render

static setNavigator(Navigator nav)

Updates the current state of your navigator, you must pass the second argument retorned in the renderScene funcion of the Navigator component


static index()

Returns the index component


static openView(String name, Object params)

Opens a new view, if the view was already registered in the stack it will replace it and any state will be reset. The params object wil be used to pass parameters to the view.


static jumpTo(String name, Object params)

Moves to a view previously added to the stack, if the view is not in the stack(was never open) it will be opened and added. This is the best option to move to a view. The current state of the view will not be reset.


static jumpAndReset(String name, Object params)

Moves to a view and deletes all the other views from the stack to make this the first one.


static jumpBack()

Moves to the previous view without unmounting and reseting de state of the current view.


static closeView()

Moves to the previous view unmounting and reseting the state of the current view.


Sidemenu

A sidemenu component built on top of Drawer that works in both android and ios. This sidemenu must be the top component and the views are renderd as its children.

Sample:

<SideMenu 
    opened={this.state.isMenuOpen}
    items={this.state.menuItems}
    itemPressed={(item)=>{
      actions.isMenuOpen(false);
      setTimeout(()=>Router.jumpTo(item.route),300);
      
    }}
  >
      <Component _params={route._params} />
  </SideMenu>

Props

opened(Boolean) To handle when the menu is visible or not.

style(Object) To give style to the menu component, behaves as a react View

items(Mixed) The items prop are the elements that will be rendered inside de menu element, there are two options to use in here.

1- An array of objects containing at least a 'value' that will be used to list in the menu. You -can also pass a 'icon' with a string of a material icon name to use next to the value. And other than that you can add any other parameter you need.

[
  {value: 'Home', icon: 'home', 'route': 'index'},
  {value: 'Plantillas', icon: 'color-lens', 'route': 'templates'},
]

Note that the items onPress will be handled with the itemPressed prop, other than that a click doesn't do anything.

2- A React Component handled as you desire. I recommend using Native Base for your project because its just amazing

 <SideMenu 
    opened={this.state.isMenuOpen}
    items={
    <Container>
            <Content>
                <List>
                    <ListItem iconLeft>
                        <Icon name='ios-chatboxes' />
                        <Text>Simon Mignolet</Text>
                    </ListItem>
                    <ListItem iconLeft>
                        <Icon name='ios-alarm' />
                        <Text>Nathaniel Clyne</Text>
                        <Badge>2</Badge>
                    </ListItem>
                    <ListItem iconLeft>
                        <Icon name='ios-notifications' />
                        <Text>Dejan Lovren</Text>
                        <Text note>Note here</Text>
                    </ListItem>
                    <ListItem iconLeft iconRight>
                        <Icon name='ios-mic' />
                        <Text>Mama Sakho</Text>
                        <Icon name='ios-mic-outline' />
                    </ListItem>
                </List>
            </Content>
        </Container>
    }
    <Component _params={route._params} />
</SideMenu>

itemPressed(Function(item))

Fired when an item is clicked, it returns the object in wich that item belongs.

onClose(Function)

Fired when closing the menu.

fontColor

Color of the icon and text