开始使用

要开始使用 Navigation 3，请将该库及其任何支持库添加到您的项目中。使用下表决定要添加哪些库。

工件

名称

功能说明

工件

Navigation 3 运行时库

核心 Navigation 3 API。包含 NavEntry, EntryProvider 和关联的 DSL。

androidx.navigation3:navigation3-runtime

Navigation 3 界面库

提供用于显示内容的类，包括 NavDisplay 和 Scene。

androidx.navigation3:navigation3-ui

Navigation 3 的 ViewModel 生命周期

允许将 ViewModel 作用域限定为返回堆栈中的条目。

androidx.lifecycle:lifecycle-viewmodel-navigation3

Navigation 3 的 Material 3 自适应布局

提供用于 NavDisplay 的自适应布局（SceneStrategies、Scenes 和元数据定义）。

androidx.compose.material3.adaptive:adaptive-navigation3

在 快照构建版本中可用

KotlinX 序列化

允许对导航键进行序列化。

插件：org.jetbrains.kotlin.plugin.serialization

库

org.jetbrains.kotlinx:kotlinx-serialization-core

项目设置

要将 Navigation 3 库添加到现有项目，请将以下内容添加到您的 libs.versions.toml

[versions]
nav3Core = "1.0.0-alpha01"
lifecycleViewmodelNav3 = "1.0.0-alpha01"
kotlinSerialization = "2.1.21"
kotlinxSerializationCore = "1.8.1"
material3AdaptiveNav3 = "1.0.0-SNAPSHOT"

[libraries]
# Core Navigation 3 libraries
androidx-navigation3-runtime = { module = "androidx.navigation3:navigation3-runtime", version.ref = "nav3Core" }
androidx-navigation3-ui = { module = "androidx.navigation3:navigation3-ui", version.ref = "nav3Core" }

# Optional add-on libraries
androidx-lifecycle-viewmodel-navigation3 = { module = "androidx.lifecycle:lifecycle-viewmodel-navigation3", version.ref = "lifecycleViewmodelNav3" }
kotlinx-serialization-core = { module = "org.jetbrains.kotlinx:kotlinx-serialization-core", version.ref = "kotlinxSerializationCore" }

# Note: The Material3 adaptive layouts library for Navigation 3 is currently
# only available in snapshot builds. Follow the instructions at androidx.dev to
# add the snapshot builds repository to your project.
androidx-material3-adaptive-navigation3 = { group = "androidx.compose.material3.adaptive", name = "adaptive-navigation3", version.ref = "material3AdaptiveNav3" }

[plugins]
# Optional plugins
jetbrains-kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlinSerialization"}

另外，将您的编译 SDK 更新到 36 或更高版本

[versions]
compileSdk = "36"

将以下内容添加到您的 app 构建文件 app/build.gradle.kts

plugins {
    ...
    // Optional, provides the @Serialize annotation for autogeneration of Serializers.
    alias(libs.plugins.jetbrains.kotlin.serialization)
}

dependencies {
    ...
    implementation(libs.androidx.navigation3.ui)
    implementation(libs.androidx.navigation3.runtime)
    implementation(libs.androidx.lifecycle.viewmodel.navigation3)
    implementation(libs.androidx.material3.adaptive.navigation3)
    implementation(libs.kotlinx.serialization.core)
}