:core:navigation/dev.atick.core.navigation/NavigationState

NavigationState

class NavigationState(val startKey: NavKey, val topLevelStack: NavBackStack<NavKey>, val subStacks: Map<NavKey, NavBackStack<NavKey>>)(source)

Holds the app's navigation state. This class never modifies itself — all changes go through Navigator, which keeps "what the state is" separate from "what a navigation event does".

Constructors

NavigationState

constructor(startKey: NavKey, topLevelStack: NavBackStack<NavKey>, subStacks: Map<NavKey, NavBackStack<NavKey>>)

Properties

backStack

val NavigationState.backStack: List<NavKey>

The flattened back stack NavDisplay renders: every visited top-level destination's stack, in the order those destinations were visited.

currentKey

val currentKey: NavKey

The destination actually on screen.

currentSubStack

val currentSubStack: NavBackStack<NavKey>

The back stack belonging to currentTopLevelKey.

currentTopLevelKey

val currentTopLevelKey: NavKey

The top-level destination currently shown, i.e. the selected navigation bar item.

startKey

val startKey: NavKey

The destination the user exits the app from.

subStacks

val subStacks: Map<NavKey, NavBackStack<NavKey>>

One back stack per top-level destination.

topLevelKeys

val topLevelKeys: Set<NavKey>

Every top-level destination.

topLevelStack

val topLevelStack: NavBackStack<NavKey>

The order in which top-level destinations were visited.