Mulai

Untuk memulai Navigasi 3, tambahkan library ke project Anda beserta library pendukung. Gunakan tabel di bawah untuk menentukan library yang akan ditambahkan.

Artefak

Nama

Fungsinya

Artefak

Library runtime Navigation 3

Core Navigation 3 API. Mencakup NavEntry, EntryProvider dan DSL terkait.

androidx.navigation3:navigation3-runtime

Library UI Navigation 3

Menyediakan class untuk menampilkan konten, termasuk NavDisplay dan Scene.

androidx.navigation3:navigation3-ui

Siklus Proses ViewModel untuk Navigation 3

Mengizinkan ViewModel dibatasi untuk entri di data sebelumnya.

androidx.lifecycle:lifecycle-viewmodel-navigation3

Tersedia di build snapshot

Tata letak adaptif Material 3 untuk Navigasi 3

Memberikan tata letak adaptif (SceneStrategies, Scene, dan definisi metadata) untuk digunakan dengan NavDisplay.

androidx.compose.material3.adaptive:adaptive-navigation3

Tersedia di build snapshot

Serialisasi KotlinX

Memungkinkan kunci navigasi diserialisasi.

Plugin: org.jetbrains.kotlin.plugin.serialization

Library:

org.jetbrains.kotlinx:kotlinx-serialization-core

org.jetbrains.kotlinx:kotlinx-serialization-json

Penyiapan project

Untuk menambahkan library Navigation 3 ke project yang ada, tambahkan kode berikut ke 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"}

Tambahkan kode berikut ke file build aplikasi 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)
}