หากต้องการเริ่มต้นใช้งาน Navigation 3 ให้เพิ่มไลบรารีลงในโปรเจ็กต์พร้อมกับไลบรารีที่รองรับ ใช้ตารางด้านล่างเพื่อตัดสินใจว่าจะเพิ่มไลบรารีใด
สิ่งประดิษฐ์
ชื่อ |
การทำงาน |
อาร์ติแฟกต์ |
---|---|---|
Navigation 3 runtime library |
Core Navigation 3 API รวมถึง |
androidx.navigation3:navigation3-runtime |
ไลบรารี UI ของ Navigation 3 |
มีคลาสสำหรับแสดงเนื้อหา ซึ่งรวมถึง |
androidx.navigation3:navigation3-ui |
วงจรการใช้งาน ViewModel สำหรับการนำทาง 3 |
ช่วยให้กำหนดขอบเขต ViewModel ให้กับรายการใน Back Stack ได้ |
androidx.lifecycle:lifecycle-viewmodel-navigation3 |
เลย์เอาต์แบบปรับได้ของ Material 3 สำหรับการนำทาง 3 |
มีเลย์เอาต์แบบปรับอัตโนมัติ (SceneStrategies, Scenes และคำจำกัดความของข้อมูลเมตา) สำหรับใช้กับ NavDisplay |
androidx.compose.material3.adaptive:adaptive-navigation3 พร้อมใช้งานในบิลด์สแนปชอต |
อนุญาตให้จัดลำดับคีย์การนำทาง |
ปลั๊กอิน: 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 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)
}