Package-level declarations

Types

Link copied to clipboard
class BackstackLifecycle(val entry: NavigationEntry, navigationStateFlow: StateFlow<NavigationState>, storeAccessor: StoreAccessor, lifecycleScope: CoroutineScope) : CoroutineScope

Lifecycle manager for a screen in the backstack.

Link copied to clipboard
sealed interface ContentInsets
Link copied to clipboard
sealed interface DismissAction
Link copied to clipboard
data class Dismissal(val back: DismissAction = DismissAction.Pop, val tapOutside: DismissAction = DismissAction.Ignore, val swipe: DismissAction = DismissAction.Pop)
Link copied to clipboard
sealed interface DismissIndicatorPlacement
Link copied to clipboard
Link copied to clipboard

A declarable navigation graph, the structural counterpart to Screen and Modal.

Link copied to clipboard
interface LoadingModal : Modal

A full-screen SYSTEM overlay shown while a guard or entry definition is evaluating.

Link copied to clipboard
interface Modal : Navigatable
Link copied to clipboard
@Serializable
data class MutableNavigationGraph(val route: String, val startDestination: StartDestination? = null, val navigatables: List<Navigatable>, val nestedGraphs: List<NavigationGraph>, val layout: @Composable (@Composable () -> Unit) -> Unit? = null, val declaration: Graph? = null, val interceptDefinition: InterceptDefinition? = null, val entryDefinition: EntryDefinition? = null, val navigatableIntercepts: NavigatableInterceptMap = emptyMap()) : NavigationGraph
Link copied to clipboard
Link copied to clipboard

A named group of Navigatable destinations and optional nested sub-graphs.

Link copied to clipboard
interface NavigationNode
Link copied to clipboard
data class NavigationPath(val route: String) : NavigationNode

A lightweight NavigationNode that wraps a plain route string.

Link copied to clipboard
@Serializable
sealed class NavigationTarget
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Reason why an entry is being removed from the backstack.

Link copied to clipboard
interface Screen : Navigatable

A full-screen destination rendered in the RenderLayer.CONTENT layer.

Link copied to clipboard
open class ScreenGroup(val screens: List<Screen>)
Link copied to clipboard
@Serializable
sealed class StartDestination
Link copied to clipboard
interface UrlEncoder
Link copied to clipboard
@Serializable
enum WindowWidthClass : Enum<WindowWidthClass>

Functions

Link copied to clipboard