NavigationState

class NavigationState(val startRoute: NavKey, topLevelRoute: MutableState<NavKey>, val topLevelRoutes: Set<NavigationKey>, val backStacks: Map<NavKey, NavBackStack<NavKey>>)

State holder for navigation state.

Parameters

startRoute
  • the start route. The user will exit the app through this route.

topLevelRoute
  • the current top level route

backStacks
  • the back stacks for each top level route

Constructors

Link copied to clipboard
constructor(startRoute: NavKey, topLevelRoute: MutableState<NavKey>, topLevelRoutes: Set<NavigationKey>, backStacks: Map<NavKey, NavBackStack<NavKey>>)

Properties

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
fun toDecoratedEntries(entryDecorators: List<NavEntryDecorator<NavKey>> = listOf(), entryProvider: (NavKey) -> NavEntry<NavKey>): List<NavEntry<NavKey>>

Convert the navigation state into NavEntrys that have been decorated with a SaveableStateHolder.