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

Package-level declarations

Types

NavBackStackController

class NavBackStackController

纯 Kotlin 导航回退栈控制器。 Pure Kotlin navigation back-stack controller.

NavBackStackSnapshot

class NavBackStackSnapshot(entries: List<NavEntry>)

单个导航栈的不可变快照。 Immutable snapshot of one navigation stack.

NavCommand

sealed interface NavCommand

导航控制器支持的状态变更命令。 State mutation commands supported by the navigation controller.

NavDeepLink

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

图节点允许匹配的一个 URI pattern。 One allowlisted URI pattern for a graph node.

NavDeepLinkArgumentType

enum NavDeepLinkArgumentType : Enum<NavDeepLinkArgumentType>

deep link 占位参数的目标类型。 Target type for a deep-link placeholder argument.

NavDeepLinkLaunchMode

enum NavDeepLinkLaunchMode : Enum<NavDeepLinkLaunchMode>

deep link 命中后对目标 stack 的打开方式。 Launch mode applied to the target stack after a deep link matches.

NavDeepLinkMatch

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

deep link 成功匹配后的 route 输出。 Route output produced by a successful deep-link match.

NavDeepLinkRejection

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

deep link 拒绝详情，包含失败参数或冲突 pattern。 Deep-link rejection details, including the failed argument or conflicting patterns.

NavDeepLinkRejectionReason

enum NavDeepLinkRejectionReason : Enum<NavDeepLinkRejectionReason>

deep link 被拒绝的可诊断原因。 Diagnostic reason why a deep link was rejected.

NavDeepLinkResolution

sealed interface NavDeepLinkResolution

deep link 解析结果。 Result of resolving a deep link.

NavDestination

class NavDestination : NavGraphNode

导航图中的叶子目的地。 Leaf destination inside a navigation graph.

NavEntry

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

回退栈上的一个目的地实例。 One destination instance on a back stack.

NavEntryId

@JvmInline

value class NavEntryId(val value: String)

单个导航目的地或图实例在回退栈中的稳定 ID。 Stable ID for one destination or graph instance on the navigation back stack.

NavEntryIdFactory

fun interface NavEntryIdFactory

NavEntryId 生成器，测试可注入确定性 ID。 NavEntryId factory; tests can inject deterministic IDs.

NavEntryLifecycleState

enum NavEntryLifecycleState : Enum<NavEntryLifecycleState>

单个导航 entry 的目标生命周期状态。 Target lifecycle state for one navigation entry.

NavGraph

class NavGraph : NavGraphNode

不可变导航图，提供 route 解析、startDestination 展开和 deep-link 匹配。 Immutable navigation graph that resolves routes, expands start destinations, and matches deep links.

NavGraphBuilder

class NavGraphBuilder

navigation DSL 的可变构建器，最终输出不可变 NavGraph。 Mutable builder for the navigation DSL that produces an immutable NavGraph.

NavGraphDsl

@DslMarker

annotation class NavGraphDsl

限制导航图 DSL 的接收者作用域。 Restricts receiver scope for the navigation graph DSL.

NavGraphEntry

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

回退栈上一个具体导航图实例的稳定身份和参数。 Stable identity and arguments for one concrete navigation-graph instance on the back stack.

NavGraphNode

sealed interface NavGraphNode

导航图中的节点契约，可能是 destination 或嵌套 graph。 Node contract inside a navigation graph, either a destination or a nested graph.

NavGraphResolution

class NavGraphResolution

NavGraph 解析结果，包含实际 destination 和所属 graphPath。 NavGraph resolution containing the concrete destination and owning graphPath.

NavHostLifecycleState

enum NavHostLifecycleState : Enum<NavHostLifecycleState>

Android host 生命周期的抽象状态。 Abstract lifecycle state of the Android host.

NavLaunchMode

enum NavLaunchMode : Enum<NavLaunchMode>

push 命令的入栈模式。 Stack insertion mode for push commands.

NavLifecyclePlan

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

一次生命周期规划的目标状态和有序迁移。 Target states and ordered transitions for one lifecycle planning pass.

NavLifecyclePlanner

object NavLifecyclePlanner

根据 retained/visible/interactive entry 集合计算生命周期迁移。 Computes lifecycle transitions from retained, visible, and interactive entry sets.

NavLifecycleTransition

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

entry 生命周期状态迁移记录。 Lifecycle-state transition record for one entry.

NavNoChangeReason

enum NavNoChangeReason : Enum<NavNoChangeReason>

prepare 没有产生状态变化时的原因。 Reason why prepare produced no state change.

NavPane

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

一个 pane 与其展示 entry 的绑定。 Binding between one pane and the entry it displays.

NavPaneRole

enum NavPaneRole : Enum<NavPaneRole>

多 pane 导航布局中的逻辑角色。 Logical role in a multi-pane navigation layout.

NavPaneScene

class NavPaneScene(panes: List<NavPane>)

当前导航快照应展示的 pane 场景。 Pane scene that should be displayed for the current navigation snapshot.

NavPaneStrategies

object NavPaneStrategies

内置 pane 策略集合。 Built-in pane strategy collection.

NavPaneStrategy

fun interface NavPaneStrategy

根据 back stack 与最大 pane 数计算可见 pane 场景。 Calculates the visible pane scene from a back stack and maximum pane count.

NavPreparation

sealed interface NavPreparation

导航命令预执行结果。 Result of preparing a navigation command.

NavRootBackBehavior

enum NavRootBackBehavior : Enum<NavRootBackBehavior>

活跃 stack 已位于根节点时的系统 Back 行为。 System-Back behavior when the active stack is already at its root.

NavRoute

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

导航 route 名称及其不可变参数集合。 Navigation route name plus immutable argument map.

NavStackConfiguration

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

多个独立保留导航栈的不可变配置。 Immutable configuration for a set of 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)

一个导航事务中新增和移除的 entry 摘要。 Summary of entries added and removed by one navigation transaction.

NavStackSelectionMode

enum NavStackSelectionMode : Enum<NavStackSelectionMode>

应用选择某个 stack 时采用的行为。 Behavior applied when an application selects a 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)

声明一个独立保留导航栈的初始 route。 Declares the initial route of one independently retained navigation stack.

NavTransaction

class NavTransaction : AutoCloseable

可提交或回滚的导航事务。 Navigation transaction that can be committed or rolled back.

NavTransactionStatus

enum NavTransactionStatus : Enum<NavTransactionStatus>

导航事务状态。 Navigation transaction state.

NavValue

sealed interface NavValue

导航参数的跨平台值模型。 Cross-platform value model for navigation arguments.

Functions

calculateValidated

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

执行 pane 策略并校验输出仍引用当前 back stack。 Runs a pane strategy and validates that it still references the current back stack.

navGraph

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

构建一个不可变导航图。 Builds an immutable navigation graph.