NavigatorIOS # | Edit on GitHub |
NavigatorIOS wraps UIKit navigation and allows you to add back-swipe functionality across your app.
NOTE: This Component is not maintained by Facebook
This component is under community responsibility. If a pure JavaScript solution fits your needs you may try the
Navigator
component instead.
A route is an object used to describe each page in the navigator. The first
route is provided to NavigatorIOS as initialRoute
:
Now MyView will be rendered by the navigator. It will receive the route
object in the route
prop, a navigator, and all of the props specified in
passProps
.
See the initialRoute propType for a complete definition of a route.
A navigator
is an object of navigation functions that a view can call. It
is passed as a prop to any component rendered by NavigatorIOS.
Navigator functions are also available on the NavigatorIOS component:
Props passed to the NavigatorIOS component will set the default configuration for the navigation bar. Props passed as properties to a route object will set the configuration for that route's navigation bar, overriding any props passed to the NavigatorIOS component.
The default background color of the navigation bar
NavigatorIOS uses "route" objects to identify child views, their props, and navigation bar configuration. "push" and all the other navigation operations expect routes to be like this:
A Boolean value that indicates whether the interactive pop gesture is enabled. Useful for enabling/disabling the back swipe navigation gesture. If this prop is not provided, the default behavior is for the back swipe gesture to be enabled when the navigation bar is shown and disabled when the navigation bar is hidden. Once you've provided the interactivePopGestureEnabled prop, you can never restore the default behavior.
The default wrapper style for components in the navigator. A common use case is to set the backgroundColor for every page
A Boolean value that indicates whether the navigation bar is hidden by default
A Boolean value that indicates whether to hide the 1px hairline shadow by default
The default color used for buttons in the navigation bar
The default text color of the navigation bar title
A Boolean value that indicates whether the navigation bar is translucent by default
Navigate forward to a new route
Go back N pages at once. When N=1, behavior matches pop()
Go back one page
Replace a route in the navigation stack.
index
specifies the route in the stack that should be replaced.
If it's negative, it counts from the back.
Replace the route for the current page and immediately load the view for the new route.
Replace the route/view for the previous page.
Go back to the top item
Go back to the item for a particular route object
Replaces the previous route/view and transitions back to it.
Replaces the top item and popToTop
Examples # | Edit on GitHub |