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

Package-level declarations

Types

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

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".

Navigator

@Stable

class Navigator(val state: NavigationState)

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

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.

Functions

rememberDefaultEntryDecorators

@Composable

fun rememberDefaultEntryDecorators(): List<NavEntryDecorator<NavKey>>

The decorators every destination is wrapped in.

rememberNavigationState

@Composable

fun rememberNavigationState(startKey: NavKey, topLevelKeys: Set<NavKey>): NavigationState

Creates a NavigationState that survives configuration changes and process death.