react-native-navigation/docs/api/Navigation.md

Navigation

Element

Element (React.ComponentType<object>)

---

store

store (Store)

---

registerComponent

registerComponent(componentName: string, getComponentClassFunc: ComponentProvider): ComponentType<any>

source

Every navigation component in your app must be registered with a unique name. The component itself is a traditional React component extending React.Component.

---

setRoot

setRoot(layout: any): Promise<any>

source

Reset the app to a new layout

---

setDefaultOptions

setDefaultOptions(options: any): void

source

Set default options to all screens. Useful for declaring a consistent style across the app.

---

mergeOptions

mergeOptions(componentId: string, options: any): void

source

Change a component’s navigation options

---

showModal

showModal(layout: any): Promise<any>

source

Show a screen as a modal.

---

dismissModal

dismissModal(componentId: string): Promise<any>

source

Dismiss a modal by componentId. The dismissed modal can be anywhere in the stack.

---

dismissAllModals

dismissAllModals(): Promise<any>

source

Dismiss all Modals

---

push

push(componentId: string, layout: any): Promise<any>

source

Push a new layout into this screen’s navigation stack.

---

pop

pop(componentId: string, params: any): Promise<any>

source

Pop a component from the stack, regardless of it’s position.

---

popTo

popTo(componentId: string): Promise<any>

source

Pop the stack to a given component

---

popToRoot

popToRoot(componentId: string): Promise<any>

source

Pop the component’s stack to root.

---

setStackRoot

setStackRoot(componentId: string, layout: any): Promise<any>

source

Sets new root component to stack.

---

showOverlay

showOverlay(layout: any): Promise<any>

source

Show overlay on top of the entire app

---

dismissOverlay

dismissOverlay(componentId: string): Promise<any>

source

dismiss overlay by componentId

---

getLaunchArgs

getLaunchArgs(): Promise<any>

source

Resolves arguments passed on launch

---

events

events(): EventsRegistry

source

Obtain the events registry instance

---

constants

constants(): Promise<any>

source

Constants coming from native

---