Navigation.md 3.5KB
Navigation.md 3.5KB
Navigation
- Navigation
- .registerContainer(containerName, getContainerFunc)
- .setRoot(root)
- .setDefaultOptions(options)
- .setOptions(containerId, options)
- .showModal(params)
- .dismissModal(containerId)
- .dismissAllModals()
- .push(containerId, params)
- .pop(containerId, params)
- .popTo(containerId)
- .popToRoot(containerId)
- .events()
navigation.registerContainer(containerName, getContainerFunc)
Every screen component in your app must be registered with a unique name. The component itself is a traditional React component extending React.Component.
| Param | Type | Description |
|---|---|---|
| containerName | string |
Unique container name |
| getContainerFunc | function |
generator function, typically () => require('./myContainer') |
navigation.setRoot(root)
Reset the navigation stack to a new screen (the stack root is changed).
| Param | Type |
|---|---|
| root | Root |
navigation.setDefaultOptions(options)
Set default options to all screens. Useful for declaring a consistent style across the app.
| Param | Type |
|---|---|
| options | NavigationOptions |
navigation.setOptions(containerId, options)
Change a containers navigation options
| Param | Type | Description |
|---|---|---|
| containerId | string |
The container’s id. |
| options | NavigationOptions |
navigation.showModal(params)
Show a screen as a modal.
| Param | Type |
|---|---|
| params | Object |
navigation.dismissModal(containerId)
Dismiss a modal by containerId. The dismissed modal can be anywhere in the stack.
| Param | Type | Description |
|---|---|---|
| containerId | String |
The container’s id. |
navigation.dismissAllModals()
Dismiss all Modals
navigation.push(containerId, params)
Push a new screen into this screen’s navigation stack.
| Param | Type | Description |
|---|---|---|
| containerId | String |
The container’s id. |
| params | * |
navigation.pop(containerId, params)
Pop a container from the stack, regardless of it’s position.
| Param | Type | Description |
|---|---|---|
| containerId | String |
The container’s id. |
| params | * |
navigation.popTo(containerId)
Pop the stack to a given container
| Param | Type | Description |
|---|---|---|
| containerId | String |
The container’s id. |
navigation.popToRoot(containerId)
Pop the container’s stack to root.
| Param | Type |
|---|---|
| containerId | * |
navigation.events()
Obtain the events registery instance