เริ่มใช้งาน

หากต้องการเริ่มต้นใช้งาน Navigation 3 ให้เพิ่มไลบรารีลงในโปรเจ็กต์พร้อมกับไลบรารีที่รองรับ ใช้ตารางด้านล่างเพื่อตัดสินใจว่าควรเพิ่มคลังใด

สิ่งประดิษฐ์

ชื่อ

สิ่งที่ทํา

อาร์ติแฟกต์

ไลบรารีรันไทม์ของ Navigation 3

Core Navigation 3 API รวมถึง NavEntry, EntryProvider และ DSL ที่เกี่ยวข้อง

androidx.navigation3:navigation3-runtime

ไลบรารี UI ของ Navigation 3

มีคลาสสำหรับแสดงเนื้อหา ซึ่งรวมถึง NavDisplay และ Scene

androidx.navigation3:navigation3-ui

วงจรชีวิตของ ViewModel สําหรับการนําทาง 3

อนุญาตให้กําหนดขอบเขต ViewModel ให้กับรายการในกองซ้อนด้านหลัง

androidx.lifecycle:lifecycle-viewmodel-navigation3

พร้อมใช้งานในบิลด์สแนปชอต

เลย์เอาต์แบบปรับขนาดได้ของ Material 3 สําหรับการนําทาง 3

ให้เลย์เอาต์แบบปรับเปลี่ยนได้ (SceneStrategies, Scenes และคำจำกัดความของข้อมูลเมตา) สำหรับใช้กับ NavDisplay

androidx.compose.material3.adaptive:adaptive-navigation3

พร้อมใช้งานในบิลด์สแนปชอต

การแปลงข้อมูล 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"}

เพิ่มโค้ดต่อไปนี้ลงในไฟล์บิลด์ 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)
    implementation(libs.androidx.lifecycle.viewmodel.navigation3)
    implementation(libs.androidx.material3.navigation3)
    implementation(libs.kotlinx.serialization.core)
    implementation(libs.kotlinx.serialization.json)
}