viewcompose-navigation-core/com.viewcompose.navigation.core

Package-level declarations

Types

NavBackStackController

class NavBackStackController

Thread-safe, platform-neutral controller for transactional single- or multi-stack navigation.

NavBackStackSnapshot

class NavBackStackSnapshot(entries: List<NavEntry>)

Immutable, non-empty snapshot of one retained navigation stack.

NavCommand

sealed interface NavCommand

Immutable state-mutation command accepted by NavBackStackController.prepare.

NavDeepLink

class NavDeepLink(val uriPattern: String, argumentTypes: Map<String, NavDeepLinkArgumentType> = emptyMap(), val targetStackId: NavStackId? = null)

Allowlisted absolute URI pattern registered on one graph node.

NavDeepLinkArgumentType

enum NavDeepLinkArgumentType : Enum<NavDeepLinkArgumentType>

Target type used to decode one deep-link placeholder.

NavDeepLinkLaunchMode

enum NavDeepLinkLaunchMode : Enum<NavDeepLinkLaunchMode>

Mutation applied to the target stack after a deep link matches.

NavDeepLinkMatch

data class NavDeepLinkMatch(val deepLink: NavDeepLink, val route: NavRoute)

Route produced by a successful deep-link match.

NavDeepLinkRejection

class NavDeepLinkRejection(val reason: NavDeepLinkRejectionReason, val argumentName: String? = null, matchingPatterns: List<String> = emptyList())

Diagnostic details for a rejected deep-link input.

NavDeepLinkRejectionReason

enum NavDeepLinkRejectionReason : Enum<NavDeepLinkRejectionReason>

Diagnostic reason why a deep link was rejected instead of reported as no match.

NavDeepLinkResolution

sealed interface NavDeepLinkResolution

Exhaustive result of resolving one input URI.

NavDestination

class NavDestination : NavGraphNode

Leaf destination inside a navigation graph.

NavEntry

class NavEntry(val id: NavEntryId, val route: NavRoute, graphEntries: List<NavGraphEntry> = emptyList())

Immutable destination instance retained on a navigation back stack.

NavEntryId

@JvmInline

value class NavEntryId(val value: String)

Stable identity of one destination or navigation-graph instance on a retained back stack.

NavEntryIdFactory

fun interface NavEntryIdFactory

Allocates globally unique NavEntryId values for a controller.

NavEntryLifecycleState

enum NavEntryLifecycleState : Enum<NavEntryLifecycleState>

Lifecycle state assigned to one retained navigation entry or graph owner.

NavGraph

class NavGraph : NavGraphNode

Immutable navigation graph that resolves routes, expands nested starts, and matches deep links.

NavGraphBuilder

class NavGraphBuilder

Mutable DSL receiver that produces an immutable NavGraph.

NavGraphDsl

@DslMarker

annotation class NavGraphDsl

Restricts implicit receivers while declaring a navigation graph.

NavGraphEntry

class NavGraphEntry(val id: NavEntryId, val route: NavRoute)

Stable owner for one concrete navigation-graph instance on a back stack.

NavGraphNode

sealed interface NavGraphNode

Node inside an immutable navigation graph, either a leaf destination or a nested graph.

NavGraphResolution

class NavGraphResolution

Resolved leaf destination and its graph-owner path.

NavHostLifecycleState

enum NavHostLifecycleState : Enum<NavHostLifecycleState>

Platform-neutral lifecycle state that caps every navigation owner hosted by Android.

NavLaunchMode

enum NavLaunchMode : Enum<NavLaunchMode>

Stack insertion mode for NavCommand.Push.

NavLifecyclePlan

class NavLifecyclePlan(targetStates: Map<NavEntryId, NavEntryLifecycleState>, transitions: List<NavLifecycleTransition>)

Immutable result of one lifecycle planning pass.

NavLifecyclePlanner

object NavLifecyclePlanner

Computes navigation-owner lifecycle transitions from retention and pane visibility.

NavLifecycleTransition

data class NavLifecycleTransition(val entryId: NavEntryId, val from: NavEntryLifecycleState, val to: NavEntryLifecycleState)

Lifecycle-state transition for one owner.

NavNoChangeReason

enum NavNoChangeReason : Enum<NavNoChangeReason>

Reason why preparing a valid command produced no state mutation.

NavPane

data class NavPane(val role: NavPaneRole, val entryId: NavEntryId)

Binding between one logical pane and the destination entry it displays.

NavPaneRole

enum NavPaneRole : Enum<NavPaneRole>

Logical leading-to-trailing role in a multi-pane navigation layout.

NavPaneScene

class NavPaneScene(panes: List<NavPane>)

Immutable pane scene displayed for one active navigation stack.

NavPaneStrategies

object NavPaneStrategies

Built-in deterministic pane strategies.

NavPaneStrategy

fun interface NavPaneStrategy

Calculates the visible pane scene from a back stack and pane-count limit.

NavPreparation

sealed interface NavPreparation

Exhaustive result of preparing a navigation command.

NavRootBackBehavior

enum NavRootBackBehavior : Enum<NavRootBackBehavior>

System-Back behavior when the active stack is already at its root.

NavRoute

class NavRoute(val name: String, arguments: Map<String, NavValue> = emptyMap())

Immutable navigation request containing a registered route name and typed arguments.

NavStackConfiguration

class NavStackConfiguration(val initialStackId: NavStackId, stacks: List<NavStackSpec>, val rootBackBehavior: NavRootBackBehavior = NavRootBackBehavior.Delegate)

Immutable configuration for one or more independently retained navigation stacks.

NavStackId

@JvmInline

value class NavStackId(val value: String)

Stable application identity for one independently retained navigation stack.

NavStackMutation

data class NavStackMutation(val added: List<NavEntry>, val removed: List<NavEntry>, val previousTop: NavEntry, val nextTop: NavEntry)

Destination-owner delta produced by one navigation transaction.

NavStackSelectionMode

enum NavStackSelectionMode : Enum<NavStackSelectionMode>

Behavior applied when an application selects a retained stack.

NavStackSetSnapshot

class NavStackSetSnapshot(val activeStackId: NavStackId, stacks: Map<NavStackId, NavBackStackSnapshot>, selectionHistory: List<NavStackId> = emptyList())

Complete immutable state of every retained navigation stack.

NavStackSpec

data class NavStackSpec(val id: NavStackId, val startDestination: NavRoute)

Declares one independently retained stack and its initial route.

NavTransaction

class NavTransaction : AutoCloseable

Single-use navigation transaction that can be committed or rolled back.

NavTransactionStatus

enum NavTransactionStatus : Enum<NavTransactionStatus>

Terminal state of a prepared navigation transaction.

NavValue

sealed interface NavValue

Platform-neutral value permitted in a NavRoute argument map.

Functions

calculateValidated

fun NavPaneStrategy.calculateValidated(snapshot: NavBackStackSnapshot, maxPaneCount: Int): NavPaneScene

Runs this strategy and validates its result against snapshot and maxPaneCount.

navGraph

fun navGraph(route: String, startDestination: NavRoute, deepLinks: List<NavDeepLink> = emptyList(), builder: NavGraphBuilder.() -> Unit): NavGraph

Builds and validates an immutable navigation graph.