New Documentation (#819)

* Initial commit

* Initial commit

* Clean-up title

docs/CNAME

@@ -0,0 +1 @@
+rnn-docs.junedomingo.com

docs/README.md

@@ -0,0 +1,34 @@
+
+<h1 align="center">
+  <img src="_images/logo.png"/><br>
+  React Native Navigation
+</h1>
+
+[![NPM Version](https://img.shields.io/npm/v/react-native-navigation.svg?style=flat)](https://www.npmjs.com/package/react-native-navigation)
+[![NPM Downloads](https://img.shields.io/npm/dm/react-native-navigation.svg?style=flat)](https://www.npmjs.com/package/react-native-navigation)
+[![Build Status](https://travis-ci.org/wix/react-native-navigation.svg?branch=master)](https://travis-ci.org/wix/react-native-navigation)
+[![Join us on Discord](https://img.shields.io/badge/discord-react--native--navigation-738bd7.svg?style=flat)](https://discord.gg/DhkZjq2)
+
+App-wide support for 100% native navigation with an easy cross-platform interface. For iOS, this package is a wrapper around [react-native-controllers](https://github.com/wix/react-native-controllers), but provides a simplified more abstract API over it. This abstract API will be unified with the Android solution which is currently work in progress. It also fully supports redux if you use it.
+
+<img src="https://github.com/wix/react-native/blob/master/assets/themes/bootstrap-3/images/demo.gif?raw=true" width="240">
+
+----
+
+> ### Important
+> We are currently working hard on redesigning and refactoring this project with high quality and robustness in mind. As a result, issues and pull requests will take more time to process.
+
+> To avoid any confusion and breaking existing projects, all continuous development is published under the npm tag `next`, with version `2.0.0-experimental.x`. Once stable, we will publish it as `2.0.0`. **This version supports react-native `0.40.0 and above`**.
+
+> The last stable version is `1.30.x` with npm tag `latest`. **This version supports react-native `0.25.1`**. It's installation instructions are [here](https://github.com/wix/react-native-navigation/blob/v1.x.x/README.md#installation---ios).
+
+>If you don't want your code to break on a daily basis and don't need the new features ASAP please use the `latest` version or just specify a specific version number.
+
+## Why use this package
+
+One of the major things missing from React Native core is fully featured native navigation. Navigation includes the entire skeleton of your app with critical components like nav bars, tab bars and side menu drawers.
+
+If you're trying to deliver a user experience that's on par with the best native apps out there, you simply can't compromise on JS-based components trying to fake the real thing.
+
+For example, this package replaces the native [NavigatorIOS](https://facebook.github.io/react-native/docs/navigatorios.html) that has been [abandoned](https://facebook.github.io/react-native/docs/navigator-comparison.html) in favor of JS-based solutions that are easier to maintain. For more details see in-depth discussion [here](https://github.com/wix/react-native-controllers#why-do-we-need-this-package).
+

docs/_navbar.md

@@ -0,0 +1 @@
+- [Github](https://github.com/wix/react-native-navigation/)

docs/_sidebar.md

@@ -0,0 +1,19 @@
+- Getting started
+ - [Installation - iOS](/installation-ios)
+ - [Installation - Android](/installation-android)
+ - [Usage](/usage)
+
+- Guide
+ - [Top Level API](/top-level-api)
+ - [Screen API](/screen-api)
+ - [Deep links](/deep-links)
+ - [Android Scpecific Use Cases](/android-specific-use-cases)
+ - [Third Party Libraries Support](/third-party-libraries-support)
+ - [Contributing](/contributing)
+
+- Customization
+  - [Styling the Navigator](/styling-the-navigator)
+  - [Adding Buttons to the Navigator](/adding-buttons-to-the-navigator)
+  - [Styling the Tab Bar](/styling-the-tab-bar)
+
+- [Milestones](milestones)

docs/adding-buttons-to-the-navigator.md

@@ -0,0 +1,145 @@
+# Adding buttons to the navigator
+
+Nav bar buttons can be defined per-screen by adding `static navigatorButtons = {...};` on the screen component definition. This object can also be passed when the screen is originally created; and can be overridden when a screen is pushed. Handle onPress events for the buttons by setting your handler with `navigator.setOnNavigatorEvent(callback)`.
+
+```js
+class FirstTabScreen extends Component {
+  static navigatorButtons = {
+    rightButtons: [
+      {
+        title: 'Edit', // for a textual button, provide the button title (label)
+        id: 'edit', // id for this button, given in onNavigatorEvent(event) to help understand which button was clicked
+        testID: 'e2e_rules', // optional, used to locate this view in end-to-end tests
+        disabled: true, // optional, used to disable the button (appears faded and doesn't interact)
+        disableIconTint: true, // optional, by default the image colors are overridden and tinted to navBarButtonColor, set to true to keep the original image colors
+        showAsAction: 'ifRoom' // optional, Android only. Control how the button is displayed in the Toolbar. Accepted valued: 'ifRoom' (default) - Show this item as a button in an Action Bar if the system decides there is room for it. 'always' - Always show this item as a button in an Action Bar. 'withText' - When this item is in the action bar, always show it with a text label even if it also has an icon specified. 'never' - Never show this item as a button in an Action Bar.
+      },
+      {
+        icon: require('../../img/navicon_add.png'), // for icon button, provide the local image asset name
+        id: 'add' // id for this button, given in onNavigatorEvent(event) to help understand which button was clicked
+      }
+    ]
+  };
+  constructor(props) {
+    super(props);
+    // if you want to listen on navigator events, set this up
+    this.props.navigator.setOnNavigatorEvent(this.onNavigatorEvent.bind(this));
+  }
+  onNavigatorEvent(event) { // this is the onPress handler for the two buttons together
+    if (event.type == 'NavBarButtonPress') { // this is the event type for button presses
+      if (event.id == 'edit') { // this is the same id field from the static navigatorButtons definition
+        AlertIOS.alert('NavBar', 'Edit button pressed');
+      }
+      if (event.id == 'add') {
+        AlertIOS.alert('NavBar', 'Add button pressed');
+      }
+    }
+  }
+  render() {
+    return (
+      <View style={{flex: 1}}>...</View>
+     );
+  }
+```
+
+#### Buttons object format
+
+```js
+{
+  rightButtons: [{ // buttons for the right side of the nav bar (optional)
+    title: 'Edit', // if you want a textual button
+    icon: require('../../img/navicon_edit.png'), // if you want an image button
+    id: 'compose', // id of the button which will pass to your press event handler. See the section bellow for Android specific button ids
+    testID: 'e2e_is_awesome', // if you have e2e tests, use this to find your button
+    disabled: true, // optional, used to disable the button (appears faded and doesn't interact)
+    disableIconTint: true, // optional, by default the image colors are overridden and tinted to navBarButtonColor, set to true to keep the original image colors
+  }],
+  leftButtons: [] // buttons for the left side of the nav bar (optional)
+}
+```
+
+##### Android left button
+On Android, only four button types are supported. You can use them by specifying one of the following ids in your left button definition:
+
+* back
+* cancel
+* accept
+* sideMenu
+
+> Note: It's currently not possibly to change left button icon on Android.
+
+#### Floating Action Button (FAB) - Android only
+Each screen can contain a single Fab which is displayed at the bottom right corner of the screen.
+
+* Simple Fab:
+```js
+  static navigatorButtons = {
+    fab: {
+      collapsedId: 'share',
+      collapsedIcon: require('../../img/ic_share.png'),
+      backgroundColor: '#607D8B'
+    }
+  };
+```
+
+* Fab with expanded state
+[Example](https://material-design.storage.googleapis.com/publish/material_v_9/0B8v7jImPsDi-ZmQ0UnFPZmtiSU0/components-buttons-fab-transition_speeddial_02.mp4)
+```js
+    fab: {
+      collapsedId: 'share',
+      collapsedIcon: require('../../img/ic_share.png'),
+      expendedId: 'clear',
+      expendedIcon: require('../../img/ic_clear.png'),
+      backgroundColor: '#3F51B5',
+      actions: [
+        {
+          id: 'mail',
+          icon: require('../../img/ic_mail.png'),
+          backgroundColor: '#03A9F4'
+        },
+        {
+          id: 'twitter',
+          icon: require('../../img/ic_twitter.png'),
+          backgroundColor: '#4CAF50'
+        }
+      ]
+    }
+```
+
+#### Contextual TopBar Menu - Android only
+A contextual menu offers actions that affect a specific item or context frame in the UI. You can provide a context menu for any view, but they are most often used for items in a ListView, GridView, or other view collections in which the user can perform direct actions on each item. (Taken from the [Android documentation](https://developer.android.com/guide/topics/ui/menus.html#context-menu))
+
+#### showing the contextual menu
+
+```js
+this.props.navigator.showContextualMenu(
+  {
+    rightButtons: [
+      {
+        title: 'Add',
+        icon: require('../img/add.png')
+      },
+      {
+        title: 'Delete',
+        icon: require('../img/delete.png')
+      }
+    ],
+    onButtonPressed: (index) => console.log(`Button ${index} tapped`)
+  }
+);
+```
+
+##### Hiding the contextual menu
+```js
+this.props.navigator.dismissContextualMenu();
+```
+
+
+To style the `ContextualMenu`, use the following properties in the screen's `navigatorStyle`:
+```js
+static navigatorStyle = {
+  contextualMenuStatusBarColor: '#0092d1',
+  contextualMenuBackgroundColor: '#00adf5',
+  contextualMenuButtonsColor: '#ffffff'
+};
+```

docs/android-specific-use-cases.md

@@ -0,0 +1,140 @@
+# Android Specific Use Cases
+
+TOC
+* [Activity Lifecycle and onActivityResult](https://github.com/wix/react-native-navigation/wiki/Android#activity-lifecycle-and-onactivityresult)
+* [Adjusting soft input mode](https://github.com/wix/react-native-navigation/wiki/Android/_edit#adjusting-soft-input-mode)
+* [Splash screen](https://github.com/wix/react-native-navigation/wiki/Android/_edit#splash-screen)
+* [Collapsing React header](https://github.com/wix/react-native-navigation/wiki/Android/_edit#collapsing-react-header---android-only)
+  * [Collapsing react view](https://github.com/wix/react-native-navigation/wiki/Android/_edit#collapsing-react-view)
+  * [Collapsing react view with top tabs](https://github.com/wix/react-native-navigation/wiki/Android/_edit#collapsing-react-view-with-top-tabs)
+* [Reloading from terminal](https://github.com/wix/react-native-navigation/wiki/Android/_edit#reloading-from-terminal)
+
+# Activity Lifecycle and onActivityResult
+In order to listen to activity lifecycle callbacks, set `ActivityCallback` in `MainApplication.onCreate` as follows:
+
+```java
+public class MainApplication extends NavigationApplication {
+    @Override
+    public void onCreate() {
+        super.onCreate();
+        setActivityCallbacks(new ActivityCallbacks() {
+            @Override
+            public void onActivityCreated(Activity activity, Bundle savedInstanceState) {
+                
+            }
+
+            @Override
+            public void onActivityStarted(Activity activity) {
+                
+            }
+
+            @Override
+            public void onActivityResumed(Activity activity) {
+                
+            }
+
+            @Override
+            public void onActivityPaused(Activity activity) {
+                
+            }
+
+            @Override
+            public void onActivityStopped(Activity activity) {
+                
+            }
+
+            @Override
+            public void onActivityResult(int requestCode, int resultCode, Intent data) {
+                
+            }
+
+            @Override
+            public void onActivityDestroyed(Activity activity) {
+                
+            }
+        });
+    }
+}
+```
+
+## Adjusting soft input mode
+
+```java
+public class MyApplication extends NavigationApplication {
+    @Override
+    public void onCreate() {
+        registerActivityLifecycleCallbacks(new LifecycleCallbacks() {
+            @Override
+            public void onActivityCreated(Activity activity, Bundle savedInstanceState) {
+                activity.getWindow().setSoftInputMode(WindowManager.LayoutParams.SOFT_INPUT_ADJUST_RESIZE);
+            }
+        });
+    }
+}
+```
+
+## Why overriding these methods in `MainActivity` won't work
+`MainActivity` extends `SplashActiviy` which is used to start the react context. Once react is up and running `MainActivity` is **stopped** and another activity takes over to run our app: `NavigationActivity`. Due to this design, there's usually no point in overriding lifecycle callbacks in `MainActivity`.
+
+# Splash screen
+Override `getSplashLayout` or `createSplashLayout` in `MainActivity` to provide a splash layout which will be displayed while Js context initialises.
+
+# Collapsing React header - Android only
+A screen can have a header, either an image or a react component, that collapses as the screen is scrolled.
+
+## Collapsing react view
+
+```js
+export default class CollapsingReactViewScreen extends Component {
+static navigatorStyle = {
+    navBarHideOnScroll: false,
+    navBarBackgroundColor: '#4dbce9', // This will be the TitleBars color when the react view is hidden and collapsed
+    collapsingToolBarComponent: 'example.header',
+    navBarTranslucent: true // Optional, sets a translucent dark background to the TitleBar. Useful when displaying bright colored header to emphasize the title and buttons in the TitleBar
+  };
+}
+```
+
+## Collapsing react view with top tabs
+
+**Note:** `example.header` represents a component that's registered as a screen:
+```js
+import Header  from './Header';
+Navigation.registerComponent('example.header', () => Header);
+```
+
+```js
+export default class CollapsingReactViewTopTabsScreen extends Component {
+  static navigatorStyle = {
+    navBarHideOnScroll: false, // false, since we collapse the TopBar and the TitleBar remains visible with the top tabs
+    topBarCollapseOnScroll: true,
+    navBarBackgroundColor: '#4dbce9', // This will be the TitleBar's color when the react view is hidden and collapsed
+    collapsingToolBarComponent: 'example.header', // id used to register the component
+    expendCollapsingToolBarOnTopTabChange: false, // Don't expend the TopBar when selected TopTab changes
+    collapsingToolBarCollapsedColor: '#4dbce9' // Optional, use this property with navBarTranslucent: true to animate between translucent and solid color title bar color
+  };
+}
+```
+
+Specify `topTab` in the screen object you use when starting your app:
+
+```js
+Navigation.startSingleScreenApp({
+    screen: {
+    screen: 'example.collapsingReactViewTopTabsScreen',
+    title: 'Collapsing React TopTabs View',
+    topTabs: [
+      {
+        screenId: 'example.ListScreen',
+        icon: require('../img/list.png')
+      },
+      {
+        screenId: 'example.secondTabScreen',
+        icon: require('../img/list.png')
+      }
+    ]
+});
+```
+
+# Reloading from terminal
+You can easily reload your app from terminal using `adb shell am broadcast -a react.native.RELOAD`. This is particularly useful when debugging on device.

docs/contributing.md

@@ -0,0 +1,5 @@
+# Contributing
+
+We are currently working hard on redesigning and refactoring this project with high quality and robustness in mind. As a result, issues and pull requests will take more time to process.
+
+If you have any question, you're welcome to join our [discord channel](https://discord.gg/DhkZjq2). Please try to use the issues section only for bug reports and suggestions for improvements.

docs/deep-links.md

@@ -0,0 +1,41 @@
+# Deep Links
+
+Deep links are strings which represent internal app paths/routes. They commonly appear on push notification payloads to control which section of the app should be displayed when the notification is clicked. For example, in a chat app, clicking on the notification should open the relevant conversation on the "chats" tab.
+
+Another use-case for deep links is when one screen wants to control what happens in another sibling screen. Normally, a screen can only push/pop from its own stack, it cannot access the navigation stack of a sibling tab for example. Returning to our chat app example, assume that by clicking on a contact in the "contacts" tab we want to open the relevant conversation in the "chats" tab. Since the tabs are siblings, you can achieve this behavior by triggering a deep link:
+
+```js
+onContactSelected(contactID) {
+  this.props.navigator.handleDeepLink({
+    link: 'chats/' + contactID
+  });
+}
+```
+
+> Tip: Deep links are also the recommended way to handle side drawer actions. Since the side drawer screen is a sibling to the rest of the app, it can control the other screens by triggering deep links.
+
+#### Handling deep links
+
+Every deep link event is broadcasted to all screens. A screen can listen to these events by defining a handler using `setOnNavigatorEvent` (much like listening for button events). Using this handler, the screen can filter links directed to it by parsing the link string and act upon any relevant links found.
+
+```js
+export default class SecondTabScreen extends Component {
+  constructor(props) {
+    super(props);
+    // if you want to listen on navigator events, set this up
+    this.props.navigator.setOnNavigatorEvent(this.onNavigatorEvent.bind(this));
+  }
+  onNavigatorEvent(event) {
+    // handle a deep link
+    if (event.type == 'DeepLink') {
+      const parts = event.link.split('/');
+      if (parts[0] == 'tab2') {
+        // handle the link somehow, usually run a this.props.navigator command
+      }
+    }
+  }
+```
+
+#### Deep link string format
+
+There is no specification for the format of deep links. Since you're implementing the parsing logic in your handlers, you can use any format you wish.

docs/index.html

@@ -0,0 +1,49 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>React Native Navigation - truly native navigation for iOS and Android</title>
+  <meta name="description" content="React Native Navigation - truly native navigation for iOS and Android">
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
+  <link rel="shortcut icon" href="_images/favicon.ico" type="image/x-icon">
+  <link rel="icon" href="_images/favicon.ico" type="image/x-icon">
+</head>
+<body>
+  <div id="app">
+    <img src="https://raw.githubusercontent.com/wix/react-native-navigation/master/logo.png" alt="react-native-navigation logo">
+  </div>
+</body>
+<script>
+  window.$docsify = {
+    repo: '',
+    name: 'React Native Navigation',
+    search: 'auto',
+    themeColor: '#21B8F0',
+    loadSidebar: true,
+    loadNavbar: true,
+    maxLevel: 4,
+    subMaxLevel: 2,
+    auto2top: true,
+    ga: 'UA-XXXXX-Y',
+    plugins: [
+      function (hook) {
+        var footer = [
+          '<hr/>',
+          '<footer class="Test">',
+          `<span>Caught a mistake or want to contribute to the documentation? <a href="https://github.com/wix/react-native-navigation/docs" target="_blank">Edit documentation on Github!</a>.</span>`,
+          '</footer>'
+        ].join('')
+
+        hook.afterEach(function (html) {
+          return html + footer
+        })
+      }
+    ]
+  }
+</script>
+<script src="//unpkg.com/docsify/lib/docsify.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/emoji.js"></script>
+<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
+</html>

docs/installation-android.md

@@ -0,0 +1,72 @@
+# Android Installation
+
+### Important
+The `latest` (stable) version of this framework is `1.x.x` which supports react-native `0.25.1`. It's installation instructions are [here](https://github.com/wix/react-native-navigation/blob/v1.x.x/README.md#installation---android). To use it specify `"react-native-navigation": "latest"` in your package.json dependencies.
+
+The following instructions are for the `next` version `2.0.0-experimental.x`, which supports react-native `0.37.0`. To use it specify `"react-native-navigation": "next"` in your package.json dependencies. Bear in mind, as the name of the version suggests - this version is experimental and under heavy development, and will break from time to time - thus when using it you should check out these instructions from time to time to avoid breaking your project. 
+
+----
+
+* Make sure you are using react-native version 0.37.0
+
+ >Note: Android adaptation is still under active development therfore the API might break from time to time. 
+ 
+1.  Add the following to your `settings.gradle` file located in the `android` folder:
+
+	```groovy
+	include ':react-native-navigation'
+	project(':react-native-navigation').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-navigation/android/app/')
+	```
+	
+2. Update project dependencies in `build.gradle` under `app` folder.
+
+	```groovy
+	dependencies {
+	    compile fileTree(dir: "libs", include: ["*.jar"])
+	    compile "com.android.support:appcompat-v7:23.0.1"
+	    compile "com.facebook.react:react-native:+"
+	    compile project(':react-native-navigation')
+}
+```
+
+3. Your `MainActivity` should extend `com.reactnativenavigation.controllers.SplashActivity` instead of `ReactActivity`. If you have any `react-native` related methods in your `MainActivity` you can safely delete them.
+
+4. Update the MainApplication file and update the `Application` element in `AndroidManifest.xml`
+	
+	```java
+	import com.reactnativenavigation.NavigationApplication;
+	
+	public class MainApplication extends NavigationApplication {
+	
+	}
+	```
+	
+	```xml
+	<application
+        android:name=".MainApplication"
+        ...
+        />
+	```
+5. Implement `isDebug` and `createAdditionalReactPackages` methods
+
+	```java
+	import com.reactnativenavigation.NavigationApplication;
+	
+	public class MyApplication extends NavigationApplication {
+ 
+    	@Override
+		public boolean isDebug() {
+			// Make sure you are using BuildConfig from your own application
+			return BuildConfig.DEBUG;
+		}
+
+	    @NonNull
+	    @Override
+	    public List<ReactPackage> createAdditionalReactPackages() {
+		    // Add the packages you require here.
+			// No need to add RnnPackage and MainReactPackage
+	        return null;
+	    }
+	}
+	```
+6. Run react-native start

docs/installation-ios.md

@@ -0,0 +1,23 @@
+# iOS Installation
+
+### Important
+The `latest` (stable) version of this framework is `1.x.x` which supports react-native `0.25.1`. It's installation instructions are [here](https://github.com/wix/react-native-navigation/blob/v1.x.x/README.md#installation---ios). To use it specify `"react-native-navigation": "latest"` in your package.json dependencies.
+
+The following instructions are for the `next` version `2.0.0-experimental.x`, which supports react-native `0.37.0`. To use it specify `"react-native-navigation": "next"` in your package.json dependencies. Bear in mind, as the name of the version suggests - this version is experimental and under heavy development, and will break from time to time - thus when using it you should check out these instructions from time to time to avoid breaking your project. 
+
+----
+
+ * Make sure you are using react-native version 0.37.0
+
+ * In your project folder run `npm install react-native-navigation@next --save`
+> Note: We recommend using npm ver 3+. If you insist on using npm ver 2 please notice that the location for react-native-controllers in node_modules will be under the react-native-navigation folder and you'll need to change the paths in Xcode below accordingly.
+
+* In Xcode, in Project Navigator (left pane), right-click on the `Libraries` > `Add files to [project name]`. Add `./node_modules/react-native-navigation/ios/ReactNativeNavigation.xcodeproj` ([screenshots](https://facebook.github.io/react-native/docs/linking-libraries-ios.html#step-1))
+
+* In Xcode, in Project Navigator (left pane), click on your project (top) and select the `Build Phases` tab (right pane). In the `Link Binary With Libraries` section add `libReactNativeNavigation.a` ([screenshots](https://facebook.github.io/react-native/docs/linking-libraries-ios.html#step-2))
+
+* In Xcode, in Project Navigator (left pane), click on your project (top) and select the `Build Settings` tab (right pane). In the `Header Search Paths` section add `$(SRCROOT)/../node_modules/react-native-navigation/ios`. Make sure on the right to mark this new path `recursive` ([screenshots](https://facebook.github.io/react-native/docs/linking-libraries-ios.html#step-3))
+
+* In Xcode, under your project files, modify `AppDelegate.m` according to this [example](https://github.com/wix/react-native-navigation/blob/master/example/ios/example/AppDelegate.m)
+
+* Run react-native start

docs/milestones.md

@@ -0,0 +1,24 @@
+# Milestones
+
+### [Version 2.0.0](https://github.com/wix/react-native-navigation/milestone/1)
+
+> Due by November 30, 2016
+
+#### The general goals for this version are:
+* [react-native-controllers](https://github.com/wix/react-native-controllers) will be deprecated and fully merged into [react-native-navigation](https://github.com/wix/react-native-navigation).
+* iOS - Redesign and Refactor
+* Android - Redesign and Refactor
+* Complete feature parity between Android and iOS
+
+#### The main feature that we are planning for this version are:
+* [Screens lifecycle](https://github.com/wix/react-native-navigation/labels/Screens%20Lifecycle)
+* [Pass props and functions](https://github.com/wix/react-native-navigation/labels/Passprops%20%26%20Functions)
+* [Dynamic styling](https://github.com/wix/react-native-navigation/labels/Dynamic%20styling)
+
+
+### [Version 2.1.0](https://github.com/wix/react-native-navigation/milestone/2)
+
+#### The general goals for this version are:
+* Android tests
+* iOS tests
+* Activity results

docs/screen-api.md

@@ -0,0 +1,239 @@
+# Screen API
+
+This API is relevant when in a screen component context - it allows a screen to push other screens, pop screens, change its navigator style, etc. Access to this API is available through the `navigator` object that is passed to your component through `props`.
+
+## push(params)
+
+Push a new screen into this screen's navigation stack.
+
+```js
+this.props.navigator.push({
+  screen: 'example.ScreenThree', // unique ID registered with Navigation.registerScreen
+  title: undefined, // navigation bar title of the pushed screen (optional)
+  titleImage: require('../../img/my_image.png'), //navigation bar title image instead of the title text of the pushed screen (optional)
+  passProps: {}, // simple serializable object that will pass as props to the pushed screen (optional)
+  animated: true, // does the push have transition animation or does it happen immediately (optional)
+  backButtonTitle: undefined, // override the back button title (optional)
+  backButtonHidden: false, // hide the back button altogether (optional)
+  navigatorStyle: {}, // override the navigator style for the pushed screen (optional)
+  navigatorButtons: {} // override the nav buttons for the pushed screen (optional)
+});
+```
+
+## pop(params = {})
+
+Pop the top screen from this screen's navigation stack.
+
+```js
+this.props.navigator.pop({
+  animated: true // does the pop have transition animation or does it happen immediately (optional)
+});
+```
+
+## popToRoot(params = {})
+
+Pop all the screens until the root from this screen's navigation stack.
+
+```js
+this.props.navigator.popToRoot({
+  animated: true // does the pop have transition animation or does it happen immediately (optional)
+});
+```
+
+## resetTo(params)
+
+Reset the screen's navigation stack to a new screen (the stack root is changed).
+
+```js
+this.props.navigator.resetTo({
+  screen: 'example.ScreenThree', // unique ID registered with Navigation.registerScreen
+  title: undefined, // navigation bar title of the pushed screen (optional)
+  passProps: {}, // simple serializable object that will pass as props to the pushed screen (optional)
+  animated: true, // does the push have transition animation or does it happen immediately (optional)
+  navigatorStyle: {}, // override the navigator style for the pushed screen (optional)
+  navigatorButtons: {} // override the nav buttons for the pushed screen (optional)
+});
+```
+
+## showModal(params = {})
+
+Show a screen as a modal.
+
+```js
+this.props.navigator.showModal({
+  screen: "example.ModalScreen", // unique ID registered with Navigation.registerScreen
+  title: "Modal", // title of the screen as appears in the nav bar (optional)
+  passProps: {}, // simple serializable object that will pass as props to the modal (optional)
+  navigatorStyle: {}, // override the navigator style for the screen, see "Styling the navigator" below (optional)
+  animationType: 'slide-up' // 'none' / 'slide-up' , appear animation for the modal (optional, default 'slide-up')
+});
+```
+
+## dismissModal(params = {})
+
+Dismiss the current modal.
+
+```js
+this.props.navigator.dismissModal({
+  animationType: 'slide-down' // 'none' / 'slide-down' , dismiss animation for the modal (optional, default 'slide-down')
+});
+```
+
+## dismissAllModals(params = {})
+
+Dismiss all the current modals at the same time.
+
+```js
+this.props.navigator.dismissAllModals({
+  animationType: 'slide-down' // 'none' / 'slide-down' , dismiss animation for the modal (optional, default 'slide-down')
+});
+```
+
+## showLightBox(params = {})
+
+Show a screen as a lightbox.
+
+```js
+this.props.navigator.showLightBox({
+ screen: "example.LightBoxScreen", // unique ID registered with Navigation.registerScreen
+ passProps: {}, // simple serializable object that will pass as props to the lightbox (optional)
+ style: {
+   backgroundBlur: "dark", // 'dark' / 'light' / 'xlight' / 'none' - the type of blur on the background
+   backgroundColor: "#ff000080" // tint color for the background, you can specify alpha here (optional)
+ }
+});
+```
+
+## dismissLightBox(params = {})
+
+Dismiss the current lightbox.
+
+```js
+this.props.navigator.dismissLightBox();
+```
+
+## handleDeepLink(params = {})
+
+Trigger a deep link within the app. See [deep links](#deep-links) for more details about how screens can listen for deep link events.
+
+```js
+this.props.navigator.handleDeepLink({
+  link: "chats/2349823023" // the link string (required)
+});
+```
+
+> `handleDeepLink` can also be called statically:
+```js
+  import {Navigation} from 'react-native-navigation';
+  Navigation.handleDeepLink(...);
+```
+
+## setOnNavigatorEvent(callback)
+
+Set a handler for navigator events (like nav button press). This would normally go in your component constructor.
+
+```js
+// this.onNavigatorEvent will be our handler
+this.props.navigator.setOnNavigatorEvent(this.onNavigatorEvent.bind(this));
+```
+
+## setButtons(params = {})
+
+Set buttons dynamically on the navigator. If your buttons don't change during runtime, see "Adding buttons to the navigator" below to add them using `static navigatorButtons = {...};`.
+
+```js
+this.props.navigator.setButtons({
+  leftButtons: [], // see "Adding buttons to the navigator" below for format (optional)
+  rightButtons: [], // see "Adding buttons to the navigator" below for format (optional)
+  animated: true // does the change have transition animation or does it happen immediately (optional)
+});
+```
+
+## setTitle(params = {})
+
+Set the nav bar title dynamically. If your title doesn't change during runtime, set it when the screen is defined / pushed.
+
+```js
+this.props.navigator.setTitle({
+  title: "Dynamic Title" // the new title of the screen as appears in the nav bar
+});
+```
+
+## toggleDrawer(params = {})
+
+Toggle the side menu drawer assuming you have one in your app.
+
+```js
+this.props.navigator.toggleDrawer({
+  side: 'left', // the side of the drawer since you can have two, 'left' / 'right'
+  animated: true, // does the toggle have transition animation or does it happen immediately (optional)
+  to: 'open' // optional, 'open' = open the drawer, 'closed' = close it, missing = the opposite of current state
+});
+```
+
+## toggleTabs(params = {})
+
+Toggle whether the tabs are displayed or not (only in tab-based apps).
+
+```js
+this.props.navigator.toggleTabs({
+  to: 'hidden', // required, 'hidden' = hide tab bar, 'shown' = show tab bar
+  animated: true // does the toggle have transition animation or does it happen immediately (optional)
+});
+```
+
+## setTabBadge(params = {})
+
+Set the badge on a tab (any string or numeric value).
+
+```js
+this.props.navigator.setTabBadge({
+  tabIndex: 0, // (optional) if missing, the badge will be added to this screen's tab
+  badge: 17 // badge value, null to remove badge
+});
+```
+
+## switchToTab(params = {})
+
+Switch to a tab (sets it as the currently selected tab).
+
+```js
+this.props.navigator.switchToTab({
+  tabIndex: 0 // (optional) if missing, this screen's tab will become selected
+});
+```
+
+## toggleNavBar(params = {})
+
+Toggle whether the navigation bar is displayed or not.
+
+```js
+this.props.navigator.toggleNavBar({
+  to: 'hidden', // required, 'hidden' = hide navigation bar, 'shown' = show navigation bar
+  animated: true // does the toggle have transition animation or does it happen immediately (optional). By default animated: true
+});
+```
+
+# Screen Visibility
+Listen to screen visibility events in onNavigatorEvent handler:
+
+```js
+export default class ExampleScreen extends Component {
+  constructor(props) {
+    super(props);
+    this.props.navigator.setOnNavigatorEvent(this.onNavigatorEvent.bind(this));
+  }
+  onNavigatorEvent(event) {
+    switch(event.id) {
+      case 'willAppear':
+	     break;
+      case 'didAppear':
+        break;
+      case 'willDisappear':
+        break;
+      case 'didDisappear':
+        break;
+    }
+  }
+}
+```

docs/styling-the-navigator.md

@@ -0,0 +1,55 @@
+# Styling the Navigator
+
+You can style the navigator appearance and behavior by passing a `navigatorStyle` object. This object can be passed when the screen is originally created; can be defined per-screen by setting `static navigatorStyle = {};` on the screen component; and can be overridden when a screen is pushed.
+
+The easiest way to style your screen is by adding `static navigatorStyle = {};` to your screen React component definition.
+
+```js
+export default class StyledScreen extends Component {
+  static navigatorStyle = {
+    drawUnderNavBar: true,
+    navBarTranslucent: true
+  };
+  constructor(props) {
+    super(props);
+  }
+  render() {
+    return (
+      <View style={{flex: 1}}>...</View>
+     );
+  }
+```
+
+#### Style object format
+
+```js
+{
+  navBarTextColor: '#000000', // change the text color of the title (remembered across pushes)
+  navBarBackgroundColor: '#f7f7f7', // change the background color of the nav bar (remembered across pushes)
+  navBarButtonColor: '#007aff', // change the button colors of the nav bar (eg. the back button) (remembered across pushes)
+  navBarHidden: false, // make the nav bar hidden
+  navBarHideOnScroll: false, // make the nav bar hidden only after the user starts to scroll
+  navBarTranslucent: false, // make the nav bar semi-translucent, works best with drawUnderNavBar:true
+  navBarTransparent: false, // make the nav bar transparent, works best with drawUnderNavBar:true,
+  topBarElevationShadowEnabled: false, // Android only, default: true. Disables TopBar elevation shadow on Lolipop and above
+  navBarNoBorder: false, // hide the navigation bar bottom border (hair line). Default false
+  drawUnderNavBar: false, // draw the screen content under the nav bar, works best with navBarTranslucent:true
+  drawUnderTabBar: false, // draw the screen content under the tab bar (the tab bar is always translucent)
+  statusBarBlur: false, // blur the area under the status bar, works best with navBarHidden:true
+  navBarBlur: false, // blur the entire nav bar, works best with drawUnderNavBar:true
+  tabBarHidden: false, // make the screen content hide the tab bar (remembered across pushes)
+  statusBarHideWithNavBar: false // hide the status bar if the nav bar is also hidden, useful for navBarHidden:true
+  statusBarHidden: false, // make the status bar hidden regardless of nav bar state
+  statusBarTextColorScheme: 'dark', // text color of status bar, 'dark' / 'light' (remembered across pushes)
+  statusBarTextColorSchemeSingleScreen: 'light' // same as statusBarTextColorScheme but does NOT remember across pushes
+  collapsingToolBarImage: "http://lorempixel.com/400/200/", // Collapsing Toolbar image. Android only
+  collapsingToolBarImage: require('../../img/topbar.jpg'), // Collapsing Toolbar image. Either use a url or require a local image. Android only
+  collapsingToolBarCollapsedColor: '#0f2362', // Collapsing Toolbar scrim color. Android only
+  navBarSubtitleColor: 'red', // subtitle color
+  screenBackgroundColor: 'white' // Default screen color, visible before the actual react view is rendered
+}
+```
+
+> Note: If you set any styles related to the Status Bar, make sure that in Xcode > project > Info.plist, the property `View controller-based status bar appearance` is set to `YES`.
+
+All supported styles are defined [here](https://github.com/wix/react-native-controllers#styling-navigation). There's also an example project there showcasing all the different styles.

docs/styling-the-tab-bar.md

@@ -0,0 +1,37 @@
+# Styling the Tab Bar
+
+You can style the tab bar appearance by passing a `tabsStyle` object when the app is originally created (on `startTabBasedApp`).
+
+```js
+Navigation.startTabBasedApp({
+  tabs: [ ... ],
+  tabsStyle: { // optional, **iOS Only** add this if you want to style the tab bar beyond the defaults
+    tabBarButtonColor: '#ff0000'
+  }
+});
+```
+
+#### Style object format
+
+```js
+{
+  tabBarButtonColor: '#ffff00', // change the color of the tab icons and text (also unselected)
+  tabBarSelectedButtonColor: '#ff9900', // change the color of the selected tab icon and text (only selected)
+  tabBarBackgroundColor: '#551A8B' // change the background color of the tab bar
+}
+```
+
+> *Note:* On Android, add BottomTabs styles to `AppStyle`:
+```js
+Navigation.startTabBasedApp({
+  tabs: [...],
+  appStyle: {
+    tabBarBackgroundColor: '#0f2362',
+    tabBarButtonColor: '#ffffff',
+    tabBarSelectedButtonColor: '#63d7cc'
+  },
+...
+}
+```
+
+All supported styles are defined [here](https://github.com/wix/react-native-controllers#styling-tab-bar). There's also an example project there showcasing all the different styles.

docs/third-party-libraries-support.md

@@ -0,0 +1,8 @@
+# Third Party Libraries Support
+
+### react-native-vector-icons
+
+If you would like to use [react-native-vector-icons](https://github.com/oblador/react-native-vector-icons) for your Toolbar icons, you can follow [this example](https://github.com/wix/react-native-navigation/issues/43#issuecomment-223907515) or [this](https://gist.github.com/dropfen/4a2209d7274788027f782e8655be198f) gist.
+
+### Mobx
+If you prefer Mobx over Redux, show your interest in this [thread](https://github.com/wix/react-native-navigation/issues/187). Also checkout @mastermoo's [POC](https://github.com/mastermoo/navigation-mobx-example) of using navigation with Mobx.

docs/top-level-api.md

@@ -0,0 +1,157 @@
+# Top Level API
+
+### `Navigation`
+
+```js
+import { Navigation } from 'react-native-navigation';
+```
+
+#### `registerComponent(screenID, generator, store = undefined, Provider = undefined)`
+
+Every screen component in your app must be registered with a unique name. The component itself is a traditional React component extending `React.Component`.
+
+```js
+// not using redux (just ignore the last 2 arguments)
+Navigation.registerComponent('example.FirstTabScreen', () => FirstTabScreen);
+
+// using redux, pass your store and the Provider object from react-redux
+Navigation.registerComponent('example.FirstTabScreen', () => FirstTabScreen, store, Provider);
+```
+
+#### `startTabBasedApp(params)`
+
+Change your app root into an app based on several tabs (usually 2-5), a very common pattern in iOS (like Facebook app or the iOS Contacts app). Every tab has its own navigation stack with a native nav bar.
+
+```js
+Navigation.startTabBasedApp({
+  tabs: [
+    {
+      label: 'One', // tab label as appears under the icon in iOS (optional)
+      screen: 'example.FirstTabScreen', // unique ID registered with Navigation.registerScreen
+      icon: require('../img/one.png'), // local image asset for the tab icon unselected state (optional on iOS)
+      selectedIcon: require('../img/one_selected.png'), // local image asset for the tab icon selected state (optional, iOS only. On Android, Use `tabBarSelectedButtonColor` instead)
+      title: 'Screen One', // title of the screen as appears in the nav bar (optional)
+      navigatorStyle: {}, // override the navigator style for the tab screen, see "Styling the navigator" below (optional),
+      navigatorButtons: {} // override the nav buttons for the tab screen, see "Adding buttons to the navigator" below (optional)
+    },
+    {
+      label: 'Two',
+      screen: 'example.SecondTabScreen',
+      icon: require('../img/two.png'),
+      selectedIcon: require('../img/two_selected.png'),
+      title: 'Screen Two'
+    }
+  ],
+  tabsStyle: { // optional, add this if you want to style the tab bar beyond the defaults
+    tabBarButtonColor: '#ffff00', // optional, change the color of the tab icons and text (also unselected)
+    tabBarSelectedButtonColor: '#ff9900', // optional, change the color of the selected tab icon and text (only selected)
+    tabBarBackgroundColor: '#551A8B' // optional, change the background color of the tab bar
+  },
+  drawer: { // optional, add this if you want a side menu drawer in your app
+    left: { // optional, define if you want a drawer from the left
+      screen: 'example.FirstSideMenu' // unique ID registered with Navigation.registerScreen
+    },
+    right: { // optional, define if you want a drawer from the right
+      screen: 'example.SecondSideMenu' // unique ID registered with Navigation.registerScreen
+    },
+    disableOpenGesture: false // optional, can the drawer be opened with a swipe instead of button
+  },
+  passProps: {}, // simple serializable object that will pass as props to all top screens (optional)
+  animationType: 'slide-down' // optional, add transition animation to root change: 'none', 'slide-down', 'fade'
+});
+```
+
+##### Listening to tab selected events
+In order to listen to `bottomTabSelected` event, set an `onNavigatorEventListener` on screens that are pushed to BottomTab. The event is dispatched to the top most screen pushed to the selected tab's stack.
+
+#### `startSingleScreenApp(params)`
+
+Change your app root into an app based on a single screen (like the iOS Calendar or Settings app). The screen will receive its own navigation stack with a native nav bar
+
+```js
+Navigation.startSingleScreenApp({
+  screen: {
+    screen: 'example.WelcomeScreen', // unique ID registered with Navigation.registerScreen
+    title: 'Welcome', // title of the screen as appears in the nav bar (optional)
+    navigatorStyle: {}, // override the navigator style for the screen, see "Styling the navigator" below (optional)
+    navigatorButtons: {} // override the nav buttons for the screen, see "Adding buttons to the navigator" below (optional)
+  },
+  drawer: { // optional, add this if you want a side menu drawer in your app
+    left: { // optional, define if you want a drawer from the left
+      screen: 'example.FirstSideMenu' // unique ID registered with Navigation.registerScreen
+    },
+    right: { // optional, define if you want a drawer from the right
+      screen: 'example.SecondSideMenu' // unique ID registered with Navigation.registerScreen
+    },
+    disableOpenGesture: false // optional, can the drawer be opened with a swipe instead of button
+  },
+  passProps: {}, // simple serializable object that will pass as props to all top screens (optional)
+  animationType: 'slide-down' // optional, add transition animation to root change: 'none', 'slide-down', 'fade'
+});
+```
+
+#### `showModal(params = {})`
+
+Show a screen as a modal.
+
+```js
+Navigation.showModal({
+  screen: "example.ModalScreen", // unique ID registered with Navigation.registerScreen
+  title: "Modal", // title of the screen as appears in the nav bar (optional)
+  passProps: {}, // simple serializable object that will pass as props to the modal (optional)
+  navigatorStyle: {}, // override the navigator style for the screen, see "Styling the navigator" below (optional)
+  navigatorButtons: {}, // override the nav buttons for the screen, see "Adding buttons to the navigator" below (optional)
+  animationType: 'slide-up' // 'none' / 'slide-up' , appear animation for the modal (optional, default 'slide-up')
+});
+```
+
+#### `dismissModal(params = {})`
+
+Dismiss the current modal.
+
+```js
+Navigation.dismissModal({
+  animationType: 'slide-down' // 'none' / 'slide-down' , dismiss animation for the modal (optional, default 'slide-down')
+});
+```
+
+#### `dismissAllModals(params = {})`
+
+Dismiss all the current modals at the same time.
+
+```js
+Navigation.dismissAllModals({
+  animationType: 'slide-down' // 'none' / 'slide-down' , dismiss animation for the modal (optional, default 'slide-down')
+});
+```
+
+#### `showLightBox(params = {})`
+
+Show a screen as a lightbox.
+
+```js
+Navigation.showLightBox({
+  screen: "example.LightBoxScreen", // unique ID registered with Navigation.registerScreen
+  passProps: {}, // simple serializable object that will pass as props to the lightbox (optional)
+  style: {
+    backgroundBlur: "dark", // 'dark' / 'light' / 'xlight' / 'none' - the type of blur on the background
+    backgroundColor: "#ff000080" // tint color for the background, you can specify alpha here (optional)
+  }
+});
+```
+
+#### `dismissLightBox(params = {})`
+
+Dismiss the current lightbox.
+
+```js
+Navigation.dismissLightBox();
+```
+
+#### `registerScreen(screenID, generator)`
+
+This is an internal function you probably don't want to use directly. If your screen components extend `Screen` directly (`import { Screen } from 'react-native-navigation'`), you can register them directly with `registerScreen` instead of with `registerComponent`. The main benefit of using `registerComponent` is that it wraps your regular screen component with a `Screen` automatically.
+
+```js
+Navigation.registerScreen('example.AdvancedScreen', () => AdvancedScreen);
+```

docs/usage.md

@@ -0,0 +1,72 @@
+# Usage 
+
+If you don't like reading, just jump into the fully working example projects:
+
+* [example](https://github.com/wix/react-native-navigation/tree/master/example) - Example project showing the best practice use of this package. Shows many navigation features.
+* [redux-example(**deprecated**)](https://github.com/wix/react-native-navigation/tree/master/old-example-redux) - Best practice use of this package in a [redux](https://github.com/reactjs/redux)-based project.
+
+> Note: example redux is deprecated. Since we did not have enough time and resources to maintain both example projects, we decided to stop maintaining the redux example. This does not mean redux can't be used with react-native-navigation (In fact, we use redux in the Wix app). For a working example project which uses redux with RNN you can refer to [JuneDomingo/movieapp](https://github.com/JuneDomingo/movieapp).
+
+#### Step 1 - Change the way your app starts
+
+This would normally go in your `index.ios.js`
+
+```js
+import { Navigation } from 'react-native-navigation';
+
+import { registerScreens } from './screens';
+registerScreens(); // this is where you register all of your app's screens
+
+// start the app
+Navigation.startTabBasedApp({
+  tabs: [
+    {
+      label: 'One',
+      screen: 'example.FirstTabScreen', // this is a registered name for a screen
+      icon: require('../img/one.png'),
+      selectedIcon: require('../img/one_selected.png'), // iOS only
+      title: 'Screen One'
+    },
+    {
+      label: 'Two',
+      screen: 'example.SecondTabScreen',
+      icon: require('../img/two.png'),
+      selectedIcon: require('../img/two_selected.png'), // iOS only
+      title: 'Screen Two'
+    }
+  ]
+});
+```
+
+#### Step 2 - Register all of your screen components
+
+Every screen that you want to be able to place in a tab, push to the navigation stack or present modally needs to be registered. We recommend doing this in a central place, like [`screens/index.js`](example/src/screens/index.js).
+
+> Note: Since your screens will potentially be bundled with other packages, your registered name must be **unique**! Follow a namespacing convention like `packageName.ScreenName`.
+
+```js
+import { Navigation } from 'react-native-navigation';
+
+import FirstTabScreen from './FirstTabScreen';
+import SecondTabScreen from './SecondTabScreen';
+import PushedScreen from './PushedScreen';
+
+// register all screens of the app (including internal ones)
+export function registerScreens() {
+  Navigation.registerComponent('example.FirstTabScreen', () => FirstTabScreen);
+  Navigation.registerComponent('example.SecondTabScreen', () => SecondTabScreen);
+  Navigation.registerComponent('example.PushedScreen', () => PushedScreen);
+}
+```
+
+#### Step 3 - That's it
+
+If you want to do a navigation action like push a new screen over an existing one, take a look at the [Screen API](#screen-api). It would look something like this:
+
+```js
+// this would go inside the Component implementation of one of your screens, like FirstTabScreen.js
+this.props.navigator.push({
+  screen: 'example.PushedScreen',
+  title: 'Pushed Screen'
+});
+```