כדי להתחיל להשתמש ב-Navigation 3, מוסיפים את הספרייה לפרויקט יחד עם ספריות תומכות. אפשר להיעזר בטבלה שלמטה כדי להחליט אילו ספריות להוסיף.
ממצא
שם |
מה קורה |
Artifact |
---|---|---|
ספריית זמן ריצה של Navigation 3 |
Core Navigation 3 API. כולל את |
androidx.navigation3:navigation3-runtime |
ספריית UI של Navigation 3 |
מספק מחלקות להצגת תוכן, כולל |
androidx.navigation3:navigation3-ui |
מחזור החיים של ViewModel ב-Navigation 3 |
מאפשרת להגדיר את היקף ה-ViewModels לרשומות במחסנית החזרה. |
androidx.lifecycle:lifecycle-viewmodel-navigation3 |
פריסות מותאמות של Material 3 לניווט 3 |
מספק פריסות דינמיות (SceneStrategies, Scenes והגדרות של מטא-נתונים) לשימוש עם NavDisplay. |
androidx.compose.material3.adaptive:adaptive-navigation3 זמין בגרסאות Snapshot |
מאפשרת להפוך את מקשי הניווט לסדרתיים. |
פלאגין: 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"
מוסיפים את השורות הבאות לקובץ ה-build של האפליקציה 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)
}