使ってみる

Navigation 3 を使い始めるには、サポート ライブラリとともにライブラリをプロジェクトに追加します。以下の表を参考に、追加するライブラリを決定してください。

アーティファクト

名前

行われること

アーティファクト

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 のマテリアル 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-alpha11"
lifecycleViewmodelNav3 = "2.10.0-alpha05"
kotlinSerialization = "2.1.21"
kotlinxSerializationCore = "1.8.1"
material3AdaptiveNav3 = "1.3.0-alpha01"

[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" }

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/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)
}