Merge pull request #175 from react-navigation/tab-docs

Update tab navigator docs. Closes #174

Author: brentvatne

docs/bottom-tab-navigator.md

@@ -67,10 +67,9 @@ Title string of a tab displayed in the tab bar or React Element or a function th
 
 #### `tabBarOnPress`
 
-Callback to handle tap events; the argument is an object containing:
+Callback to handle press events; the argument is an object containing:
 
-* the `previousScene: { route, index }` which is the scene we are leaving
-* the `scene: { route, index }` that was tapped
-* the `jumpToIndex` method that can perform the navigation for you
+* `navigation`: navigation prop for the screen
+* `defaultHandler`: the default handler for tab press
 
 Useful for adding a custom logic before the transition to the next scene (the tapped one) starts.

docs/material-top-tab-navigator.md

@@ -22,7 +22,6 @@ The route configs object is a mapping from route name to a route config.
 * `backBehavior` - Should the back button cause a tab switch to the initial tab? If yes, set to `initialRoute`, otherwise `none`. Defaults to `initialRoute` behavior.
 * `swipeEnabled` - Whether to allow swiping between tabs.
 * `animationEnabled` - Whether to animate when changing tabs.
-* `configureTransition` - a function that, given `currentTransitionProps` and `nextTransitionProps`, returns a configuration object that describes the animation between tabs.
 * `initialLayout` - Optional object containing the initial `height` and `width`, can be passed to prevent the one frame delay in [react-native-tab-view](https://github.com/react-native-community/react-native-tab-view#avoid-one-frame-delay) rendering.
 * `tabBarComponent` - Optional, override the component to use as the tab bar.
 * `tabBarOptions` - An object with the following properties:
@@ -77,10 +76,9 @@ Title string of a tab displayed in the tab bar or React Element or a function th
 
 #### `tabBarOnPress`
 
-Callback to handle tap events; the argument is an object containing:
+Callback to handle press events; the argument is an object containing:
 
-* the `previousScene: { route, index }` which is the scene we are leaving
-* the `scene: { route, index }` that was tapped
-* the `jumpToIndex` method that can perform the navigation for you
+* `navigation`: navigation prop for the screen
+* `defaultHandler`: the default handler for tab press
 
 Useful for adding a custom logic before the transition to the next scene (the tapped one) starts.

docs/tab-based-navigation.md

@@ -86,10 +86,9 @@ export default createBottomTabNavigator(
 
 Let's dissect this:
 
-* `tabBarIcon` is a property on `navigationOptions`, so we know we can use it on our screen components, but in this case chose to put it in the `TabNavigator` configuration in order to centralize the icon configuration for convenience.
+* `tabBarIcon` is a property on `navigationOptions`, so we know we can use it on our screen components, but in this case chose to put it in the `createBottomTabNavigator` configuration in order to centralize the icon configuration for convenience.
 * `tabBarIcon` is a function that is given the `focused` state and `tintColor`. If you take a peek further down in the configuration you will see `tabBarOptions` and `activeTintColor` and `inactiveTintColor`. These default to the the iOS platform defaults, but you can change them here. The `tintColor` that is passed through to the `tabBarIcon` is either the active or inactive one, depending on the `focused` state (focused is active).
-* In order to make the behavior the same on iOS and Android, we have explicitly provided `tabBarComponent`, `tabBarPosition`, `animationEnabled`, and `swipeEnabled`. The default behavior of `TabNavigator` is to show a tab bar on the top of the screen on Android and on the bottom on iOS, but here we force it to be on the bottom on both platforms.
-* Read the [full API reference](bottom-tab-navigator.html) for further information on `TabNavigator` configuration options.
+* Read the [full API reference](bottom-tab-navigator.html) for further information on `createBottomTabNavigator` configuration options.
 
 ## Jumping between tabs