API Reference / @gtkx/navigation / BaseNavigationContainer

Variable: BaseNavigationContainer

const BaseNavigationContainer: React.ForwardRefExoticComponent<NavigationContainerProps & React.RefAttributes<NavigationContainerRef<ParamListBase>>>

Container component which holds the navigation state. This should be rendered at the root wrapping the whole app.

Param

props.initialState

Initial state object for the navigation tree.

Param

props.onReady

Callback which is called after the navigation tree mounts.

Param

props.onStateChange

Callback which is called with the latest navigation state when it changes.

Param

props.onUnhandledAction

Callback which is called when an action is not handled.

Param

props.theme

Theme object for the UI elements.

Param

props.children

Child elements to render the content.

Param

props.ref

Ref object which refers to the navigation object containing helper methods.