開始使用

如要開始使用 Navigation 3，請將程式庫與任何支援的程式庫一併新增至專案。請參考下表，決定要新增哪些程式庫。

成果

名稱

功能

Artifact

Navigation 3 執行階段程式庫

Core Navigation 3 API。包含 NavEntry, EntryProvider 和相關的 DSL。

androidx.navigation3:navigation3-runtime

Navigation 3 UI 程式庫

提供用於顯示內容的類別，包括 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)
}