diff --git a/Libraries/Components/Navigation/NavigatorIOS.ios.js b/Libraries/Components/Navigation/NavigatorIOS.ios.js
index 9fe0af55c43375..a5eeec4c2d9f1f 100644
--- a/Libraries/Components/Navigation/NavigatorIOS.ios.js
+++ b/Libraries/Components/Navigation/NavigatorIOS.ios.js
@@ -93,10 +93,17 @@ type Event = Object;
*/
/**
- * `NavigatorIOS` is a wrapper around UIKit navigation, enabling you to
- * implement back-swipe functionality in your iOS app. Take a look at
+ * `NavigatorIOS` is a wrapper around
+ * [`UINavigationController`](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UINavigationController_Class/),
+ * enabling you to implement a navigation stack. It works exactly the same as it
+ * would on a native app using `UINavigationController`, providing the same
+ * animations and behavior from UIKIt.
+ *
+ * As the name implies, it is only available on iOS. Take a look at
* [`Navigator`](/docs/navigator.html) for a similar solution for your
- * cross-platform needs.
+ * cross-platform needs, or check out
+ * [react-native-navigation](https://github.com/wix/react-native-navigation), a
+ * component that aims to provide native navigation on both iOS and Android.
*
* To set up the navigator, provide the `initialRoute` prop with a route
* object. A route object is used to describe each scene that your app
@@ -106,13 +113,13 @@ type Event = Object;
* import React, { Component } from 'react';
* import { NavigatorIOS, Text } from 'react-native';
*
- * class NavvyIOS extends Component {
+ * export default class NavigatorIOSApp extends Component {
* render() {
* return (
*
@@ -120,39 +127,54 @@ type Event = Object;
* }
* }
*
- * class MyView extends Component {
+ * class MyScene extends Component {
+ * static propTypes = {
+ * title: PropTypes.string.isRequired,
+ * navigator: PropTypes.object.isRequired,
+ * }
+ *
+ * constructor(props, context) {
+ * super(props, context);
+ * this._onForward = this._onForward.bind(this);
+ * this._onBack = this._onBack.bind(this);
+ * }
+ *
+ * _onForward() {
+ * this.props.navigator.push({
+ * title: 'Scene ' + nextIndex,
+ * });
+ * }
+ *
* render() {
- * return(
- *
- * See you on the other nav!
- *
- * );
+ * return (
+ *
+ * Current Scene: { this.props.title }
+ *
+ * Tap me to load the next scene
+ *
+ *
+ * )
* }
* }
* ```
*
- * In this code, the navigator sets its title and renders `MyView`. The
- * component specified in `initialRoute` will receive a `route` prop and a
- * `navigator` prop representing the navigator.
+ * In this code, the navigator renders the component specified in initialRoute,
+ * which in this case is `MyScene`. This component will receive a `route` prop
+ * and a `navigator` prop representing the navigator. The navigator's navigation
+ * bar will render the title for the current scene, "My Initial Scene".
*
* You can optionally pass in a `passProps` property to your `initialRoute`.
* `NavigatorIOS` passes this in as props to the rendered component:
*
* ```
* initialRoute={{
- * component: MyView,
- * title: 'Foo This',
+ * component: MyScene,
+ * title: 'My Initial Scene',
* passProps: { myProp: 'foo' }
* }}
* ```
*
- * You can then access the props passed in:
- *
- * ```
- *
- * See you on the other nav {this.props.myProp}!
- *
- * ```
+ * You can then access the props passed in via `{this.props.myProp}`.
*
* #### Handling Navigation
*
@@ -254,6 +276,7 @@ type Event = Object;
*
* In the example above the navigation bar color is changed when the new route
* is pushed.
+ *
*/
var NavigatorIOS = React.createClass({
diff --git a/Libraries/CustomComponents/Navigator/Navigator.js b/Libraries/CustomComponents/Navigator/Navigator.js
index b79bd56fb777fd..8bf2bac6344526 100644
--- a/Libraries/CustomComponents/Navigator/Navigator.js
+++ b/Libraries/CustomComponents/Navigator/Navigator.js
@@ -130,9 +130,10 @@ var GESTURE_ACTIONS = [
/**
* `Navigator` handles the transition between different scenes in your app.
- * You should consider using this component instead of `NavigatorIOS` if you're
- * building a cross-platform app. `Navigator` is implemented in JavaScript
- * whereas `NavigatorIOS` is a wrapper around `UINavigationController`.
+ * It is implemented in JavaScript and is available on both iOS and Android. If
+ * you are targeting iOS only, you may also want to consider using
+ * [`NavigatorIOS`](docs/navigatorios.html) as it leverages native UIKit
+ * navigation.
*
* To set up the `Navigator` you provide one or more objects called routes,
* to identify each scene. You also provide a `renderScene` function that
@@ -142,13 +143,13 @@ var GESTURE_ACTIONS = [
* import React, { Component } from 'react';
* import { Text, Navigator } from 'react-native';
*
- * class NavAllDay extends Component {
+ * export default class NavAllDay extends Component {
* render() {
* return (
*
- * Hello {route.name}!
+ * Hello {route.title}!
* }
* style={{padding: 100}}
* />
@@ -158,8 +159,8 @@ var GESTURE_ACTIONS = [
* ```
*
* In the above example, `initialRoute` is used to specify the first route. It
- * contains a `name` property that identifies the route. The `renderScene`
- * prop returns a function that displays text based on the route's name.
+ * contains a `title` property that identifies the route. The `renderScene`
+ * prop returns a function that displays text based on the route's title.
*
* ### Additional Scenes
*
@@ -169,8 +170,8 @@ var GESTURE_ACTIONS = [
* ```
* render() {
* const routes = [
- * {name: 'First Scene', index: 0},
- * {name: 'Second Scene', index: 1},
+ * {title: 'First Scene', index: 0},
+ * {title: 'Second Scene', index: 1},
* ];
* return (
*
- * Hello {route.name}!
+ * Hello {route.title}!
*
* }
* style={{padding: 100}}
@@ -256,6 +257,12 @@ var GESTURE_ACTIONS = [
* This sets up a left navigator bar button that's visible on scenes after the
* the first one. When the button is tapped the navigator is popped.
*
+ * Another type of navigation bar, with breadcrumbs, is provided by
+ * `Navigator.BreadcrumbNavigationBar`. You can also provide your own navigation
+ * bar by passing it through the `navigationBar` prop. See the
+ * [UIExplorer](https://github.com/facebook/react-native/tree/master/Examples/UIExplorer)
+ * demo to try out both built-in navigation bars out and see how to use them.
+ *
* ### Scene Transitions
*
* To change the animation or gesture properties of the scene, provide a
diff --git a/docs/NavigatorComparison.md b/docs/NavigatorComparison.md
index 06a93e8be03be8..f61bec10b26244 100644
--- a/docs/NavigatorComparison.md
+++ b/docs/NavigatorComparison.md
@@ -7,52 +7,36 @@ permalink: docs/navigator-comparison.html
next: performance
---
-Mobile apps rarely consist of just one screen or scene. As soon as you add a second scene to your app, you will have to take into consideration how the user will navigate from one scene to the other.
+Mobile apps rarely consist of just one scene (another word for screen). As soon as you add a second scene to your app, you will have to take into consideration how the user will navigate from one scene to the other.
-Navigators in React Native allow you to push and pop scenes in a master/detail stack, or to pop up modal scenes. Navigators handle the transitions between scenes, and also maintain the navigational state of your application.
-
-If you are just getting started with React Native, you will probably want to start with the `Navigator` component.
+You can use navigators to transition between multiple scenes. These transitions can be typical side-to-side animations down a master/detail stack, or vertical modal popups.
## Navigator
-`Navigator` is a cross-platform implementation of a navigation stack, so it works on both iOS and Android. It is easy to customize and includes simple navigation bars.
+React Native has several built-in navigation components, but for your first app you will probably want to use `Navigator`. It provides a JavaScript implementation of a navigation stack, so it works on both iOS and Android and is easy to customize.
+
+
+
+Something you will encounter a lot when dealing with navigation is the concept of routes. A route is an object that contains information about a scene. It is used to provide all the context that the navigator's `renderScene` function needs to render a scene. A basic `Navigator` implementation may look like this:
```js
{
- // We'll get to this function soon.
+
}}
/>
```
-Something you will encounter a lot when dealing with navigation is the concept of routes. A route is an object that contains information about a scene. It is used to provide all the context the `renderScene` function needs to render a scene.
+The above example will display a single scene, but in order to push a new scene onto screen you will need to learn about `push` and `pop`. These two methods are provided by the `navigator` object that is passed to your `renderScene` function. They can be used, as you may have realized, to push and pop routes into your navigation stack.
-The `push` and `pop` functions provided by Navigator can be used to push and pop routes into the navigation stack. A more complete example that demonstrates the pushing and popping of routes could therefore look something like this:
+A more complete example that demonstrates the pushing and popping of routes could therefore look something like this:
```js
-class MyScene extends Component {
- static propTypes = {
- title: PropTypes.string.isRequired,
- onForward: PropTypes.func.isRequired,
- onBack: PropTypes.func.isRequired,
- }
- render() {
- return (
-
- Current Scene: { this.props.title }
-
- Tap me to load the next scene
-
-
- Tap me to go back
-
-
- )
- }
-}
+import React, { Component, PropTypes } from 'react';
+import { Navigator, Text, TouchableHighlight, View } from 'react-native';
-class SimpleNavigationApp extends Component {
+export default class SimpleNavigationApp extends Component {
render() {
return (
{
+
+ // Function to call when a new scene should be displayed
+ onForward={ () => {
const nextIndex = route.index + 1;
navigator.push({
title: 'Scene ' + nextIndex,
index: nextIndex,
});
}}
+
+ // Function to call to go back to the previous scene
onBack={() => {
if (route.index > 0) {
navigator.pop();
@@ -78,15 +66,40 @@ class SimpleNavigationApp extends Component {
)
}
}
+
+class MyScene extends Component {
+ static propTypes = {
+ title: PropTypes.string.isRequired,
+ onForward: PropTypes.func.isRequired,
+ onBack: PropTypes.func.isRequired,
+ }
+ render() {
+ return (
+
+ Current Scene: { this.props.title }
+
+ Tap me to load the next scene
+
+
+ Tap me to go back
+
+
+ )
+ }
+}
```
In this example, the `MyScene` component is passed the title of the current route via the `title` prop. It displays two tappable components that call the `onForward` and `onBack` functions passed through its props, which in turn will call `navigator.push()` and `navigator.pop()` as needed.
-While this is a very basic example, it can easily be adapted to render an entirely different component based on the route that is passed to the `renderScene` function. Navigator will push new scenes from the right by default, and you can control this behavior by using the `configureScene` function. Check out the [Navigator API reference](docs/navigator.html) to learn more.
+While this is a very basic example, it can easily be adapted to render an entirely different component based on the route that is passed to the `renderScene` function. Navigator will push new scenes from the right by default, and you can control this behavior by using the `configureScene` function. You can also configure a navigation bar through the `navigationBar` prop.
+
+Check out the [Navigator API reference](docs/navigator.html) for more code samples.
## NavigatorIOS
-If you are targeting iOS only, you may also want to consider using `NavigatorIOS`. It looks and feels just like `UINavigationController`, because it is actually built on top of it.
+If you are targeting iOS only, you may also want to consider using [NavigatorIOS](docs/navigatorios.html). It looks and feels just like [`UINavigationController`](https://developer.apple.com/library/ios/documentation/UIKit/Reference/UINavigationController_Class/), because it is actually built on top of it.
+
+
```js
```
-Just like Navigator, it it uses routes to represent scenes, with some important differences. The actual component that will be rendered can be specified using the `component` key in the route, and any props that should be passed to this component can be specified in `passProps`. A navigator object is automatically passed as a prop to the component, allowing you to call `push` and `pop` as needed.
+Just like Navigator, NavigatorIOS uses routes to represent scenes, with some important differences. The actual component that will be rendered can be specified using the `component` key in the route, and any props that should be passed to this component can be specified in `passProps`. A "navigator" object is automatically passed as a prop to the component, allowing you to call `push` and `pop` as needed.
+
+As NavigatorIOS leverages native UIKit navigation, it will automatically render a navigation bar with a back button and title.
Check out the [NavigatorIOS reference docs](docs/navigatorios.html) to learn more about this component.
```js
+import React, { Component, PropTypes } from 'react';
+import { NavigatorIOS, Text, TouchableHighlight, View } from 'react-native';
+
+export default class NavigatorIOSApp extends Component {
+ render() {
+ return (
+
+ )
+ }
+}
+
class MyScene extends Component {
static propTypes = {
title: PropTypes.string.isRequired,
@@ -112,7 +144,6 @@ class MyScene extends Component {
constructor(props, context) {
super(props, context);
this._onForward = this._onForward.bind(this);
- this._onBack = this._onBack.bind(this);
}
_onForward() {
@@ -121,10 +152,6 @@ class MyScene extends Component {
});
}
- _onBack() {
- this.props.navigator.pop();
- }
-
render() {
return (
@@ -132,34 +159,262 @@ class MyScene extends Component {
Tap me to load the next scene
-
- Tap me to go back
-
)
}
}
+```
+
+> You may also want to check out [react-native-navigation](https://github.com/wix/react-native-navigation), a component that aims to provide native navigation on both iOS and Android.
+
+## NavigationExperimental
+
+Navigator and NavigatorIOS are both stateful components. If your app has multiple of these, it can become tricky to coordinate navigation transitions between them. NavigationExperimental provides a different approach to navigation, allowing any view to act as a navigation view and using reducers to manipulate state at a top-level object. It is bleeding edge as the name implies, but you might want to check it out if you are craving greater control over your app's navigation.
+
+```js
+
+```
+
+You can import NavigationExperimental like any other component in React Native. Once you have that, you can deconstruct any additional components from NavigationExperimental that you may find useful. Since I am feeling like building navigation stacks today, I'll go ahead and pick out NavigationCardStack and NavigationStateUtils.
+
+```js
+import React, { Component } from 'react';
+import { NavigationExperimental } from 'react-native';
+
+const {
+ CardStack: NavigationCardStack,
+ StateUtils: NavigationStateUtils,
+} = NavigationExperimental;
+```
+
+As I said earlier, NavigationExperimental takes a different approach than Navigator and NavigatorIOS. Using it to build a navigation stack requires a few more steps than the stateful components, but the payoff is worth it.
+
+### Step 1. Define Initial State and Top Level Component
+
+Create a new component for your application. This will be the top-level object, so we will define the initial state here. The navigation state will be defined in the `navigationState` key, where we define our initial route:
+
+```js
+class BleedingEdgeApplication extends Component {
+ constructor(props, context) {
+ super(props, context);
+
+ this.state = {
+ // This defines the initial navigation state.
+ navigationState: {
+ index: 0, // Starts with first route focused.
+ routes: [{key: 'My Initial Scene'}], // Starts with only one route.
+ },
+ };
+
+ // We'll define this function later - hang on
+ this._onNavigationChange = this._onNavigationChange.bind(this);
+ }
+
+ _onNavigationChange(type) {
+ // It's literally the next step. We'll get to it!
+ }
-class NavigatorIOSApp extends Component {
render() {
return (
-
-
- }
+ This is a placeholder. We will come back to this and render our navigation here later.
+ );
+ }
+}
+```
+
+Alright, now we have a simple stateful component that doesn't do much at all. We can change that. Our initial state contains one route, and the current index. That looks suspiciously just like our initial route definition in Navigator. Do you remember which actions its navigator object provided?
+
+Push and pop, of course. That seems pretty straightforward to implement. I promised you earlier we would be using reducers to manage state at the top-level object. Sit tight.
+
+### Step 2. Reducing the Navigation State
+
+NavigationExperimental comes built-in with a some useful reducers, and they are all available as part of NavigationStateUtils. The two we will be using right now are called -- yep -- push and pop. They take a navigationState object, and return a new navigationState object.
+
+We can use them to write our `_onNavigationChange` function which, given a "push" or "pop" action, will reduce the state accordingly.
+
+```js
+_onNavigationChange(type) {
+ // Extract the navigationState from the current state:
+ let {navigationState} = this.state;
+
+ switch (type) {
+ case 'push':
+ // Push a new route, which in our case is an object with a key value.
+ // I am fond of cryptic keys (but seriously, keys should be unique)
+ const route = {key: 'Route-' + Date.now()};
+
+ // Use the push reducer provided by NavigationStateUtils
+ navigationState = NavigationStateUtils.push(navigationState, route);
+ break;
+
+ case 'pop':
+ // Pop the current route using the pop reducer.
+ navigationState = NavigationStateUtils.pop(navigationState);
+ break;
+ }
+
+ // NavigationStateUtils gives you back the same `navigationState` if nothing
+ // has changed. We will only update state if it has changed.
+ if (this.state.navigationState !== navigationState) {
+ // Always use setState() when setting a new state!
+ this.setState({navigationState});
+ // If you are new to ES6, the above is equivalent to:
+ // this.setState({navigationState: navigationState});
+ }
+}
+```
+
+Cool. I'm getting the hang of this. This is the heart of NavigationExperimental. We are only handling two actions here, but a more complex application could also take into account a "back" action (e.g. Android back button), as well as handle the transition between several tabs in a tabbed application.
+
+I am still missing the initial scene that will be rendered (as well as the actual navigator that will wrap it, but lets not get ahead of ourselves).
+
+### Step 3. Define Scenes
+
+First I want to define a Row component out of convenience. It displays some text and can call some function when pressed.
+
+```js
+class TappableRow extends Component {
+ render() {
+ return (
+
+
+ {this.props.text}
+
+
+ );
+ }
+}
+```
+
+Now I will define my actual scene. It uses a scroll view to display a vertical list of items. The first row displays the current route's key, and two more rows will call our theoretical navigator's push and pop functions.
+
+```js
+class MyVeryComplexScene extends Component {
+ render() {
+ return (
+
+
+ Route: {this.props.route.key}
+
+
+
+
+ );
+ }
+}
+```
+
+### Step 4. Create a Navigation Stack
+
+Now that I have defined the state and a function to manage it, I think I can go ahead and create a proper navigator component now. While I'm at it, I'll render my scene after configuring it with the current route's props.
+
+```js
+class MyVerySimpleNavigator extends Component {
+
+ // This sets up the methods (e.g. Pop, Push) for navigation.
+ constructor(props, context) {
+ super(props, context);
+
+ this._onPushRoute = this.props.onNavigationChange.bind(null, 'push');
+ this._onPopRoute = this.props.onNavigationChange.bind(null, 'pop');
+
+ this._renderScene = this._renderScene.bind(this);
+ }
+
+ // Now we finally get to use the `NavigationCardStack` to render the scenes.
+ render() {
+ return (
+
- )
+ );
+ }
+
+ // Render a scene for route.
+ // The detailed spec of `sceneProps` is defined at `NavigationTypeDefinition`
+ // as type `NavigationSceneRendererProps`.
+ // Here you could choose to render a different component for each route, but
+ // we'll keep it simple.
+ _renderScene(sceneProps) {
+ return (
+
+ );
}
}
```
-> You may also want to check out [react-native-navigation](https://github.com/wix/react-native-navigation), a component that aims to provide native navigation on both iOS and Android.
+That's it -- so close to the finish line I can smell it. Lets plug our new navigator into our top-level component:
+
+```js
+class BleedingEdgeApplication extends Component {
+
+ // constructor and other methods omitted for clarity
+
+ render() {
+ return (
+
+ );
+ }
+}
+```
+
+We're done! Bask in the glory of NavigationExperimental.
+
+#### Hey -- I think you are missing something.
+
+(Oh yes, sorry about that -- here's our missing imports and styles.)
+
+```js
+import { NavigationExperimental, PixelRatio, ScrollView, StyleSheet, Text, TouchableHighlight } from 'react-native';
+
+const styles = StyleSheet.create({
+ navigator: {
+ flex: 1,
+ },
+ scrollView: {
+ marginTop: 64
+ },
+ row: {
+ padding: 15,
+ backgroundColor: 'white',
+ borderBottomWidth: 1 / PixelRatio.get(),
+ borderBottomColor: '#CDCDCD',
+ },
+ rowText: {
+ fontSize: 17,
+ },
+ buttonText: {
+ fontSize: 17,
+ fontWeight: '500',
+ },
+});
+```
-## Navigation (Experimental)
+### Homework
-If you are looking for a more powerful navigation API, check out [NavigationExperimental](https://github.com/facebook/react-native/tree/master/Examples/UIExplorer/NavigationExperimental). It provides greater customization over your transitions, uses single-directional data flow using reducers to manipulate state at a top-level object, and offloads transition animations to the GPU.
+You are now an expert navigator. Take a look at [NavigationExperimental in UIExplorer](https://github.com/facebook/react-native/tree/master/Examples/UIExplorer/NavigationExperimental) to learn how to implement other types of navigation hierarchies, such as a tabbed application with multiple navigation stacks.
diff --git a/website/src/react-native/css/react-native.css b/website/src/react-native/css/react-native.css
index 4e8d3694689ba8..1d7dd728018b11 100644
--- a/website/src/react-native/css/react-native.css
+++ b/website/src/react-native/css/react-native.css
@@ -1240,7 +1240,7 @@ div[data-twttr-id] iframe {
.methodTitle {
font-weight: bold;
font-size: 24px;
- color: #E9967A;
+ color: #2F9C0A;
}
.compactProps .methodTitle {
diff --git a/website/src/react-native/img/NavigationStack-Navigator.gif b/website/src/react-native/img/NavigationStack-Navigator.gif
new file mode 100644
index 00000000000000..c1f8313996c71a
Binary files /dev/null and b/website/src/react-native/img/NavigationStack-Navigator.gif differ
diff --git a/website/src/react-native/img/NavigationStack-NavigatorIOS.gif b/website/src/react-native/img/NavigationStack-NavigatorIOS.gif
new file mode 100644
index 00000000000000..c1d56a1f555fde
Binary files /dev/null and b/website/src/react-native/img/NavigationStack-NavigatorIOS.gif differ