:core:navigation/dev.atick.core.navigation/Navigator

Navigator

class Navigator(val state: NavigationState)(source)

The single entry point for navigation events. NavigationState holds the state; this class is the only thing that changes it.

Feature modules never touch the back stacks directly — they declare fun Navigator.navigateToX() extensions next to their NavKey, which is what keeps a feature from having to know how the rest of the app is structured.

Constructors

Navigator

constructor(state: NavigationState)

Properties

state

val state: NavigationState

The state this navigator updates.

Functions

canGoBack

fun canGoBack(): Boolean

Whether goBack has somewhere to go. False means back should exit the app.

goBack

fun goBack()

Goes back one step.

navigate

fun navigate(key: NavKey)

Navigates to key, picking the behaviour from what kind of destination it is: