开始使用

如需开始使用 Navigation 3，请将该库以及所有支持库添加到您的项目中。请参考下表确定要添加哪些库。

工件

名称

用途

工件

Navigation 3 运行时库

Core 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

快照 build 中提供

适用于 Navigation 3 的 Material 3 自适应布局

提供自适应布局（SceneStrategies、Scene 和元数据定义），以便与 NavDisplay 搭配使用。

androidx.compose.material3.adaptive:adaptive-navigation3

快照 build 中提供

KotlinX 序列化

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

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

库：

org.jetbrains.kotlinx:kotlinx-serialization-core

org.jetbrains.kotlinx:kotlinx-serialization-json

项目设置

如需将 Navigation 3 库添加到现有项目，请将以下代码添加到 libs.versions.toml：

[versions]
nav3Core = "1.0.0-alpha01"
nav3Material = "1.0.0-SNAPSHOT"
nav3Lifecycle = "1.0.0-alpha01"
kotlinSerialization = "2.1.21"
kotlinxSerializationCore = "1.8.1"

[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-material3-navigation3 = { group = "androidx.compose.material3.adaptive", name = "adaptive-navigation3", version.ref = "nav3Material" }
androidx-lifecycle-viewmodel-navigation3 = { module = "androidx.lifecycle:lifecycle-viewmodel-navigation3", version.ref = "nav3Lifecycle" }
kotlinx-serialization-core = { module = "org.jetbrains.kotlinx:kotlinx-serialization-core", version.ref = "kotlinxSerializationCore" }
kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serialization-json", version.ref = "kotlinxSerializationCore" }

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

将以下内容添加到您的应用 build 文件 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)
    implementation(libs.androidx.lifecycle.viewmodel.navigation3)
    implementation(libs.androidx.material3.navigation3)
    implementation(libs.kotlinx.serialization.core)
    implementation(libs.kotlinx.serialization.json)
}