البدء

للبدء باستخدام Navigation 3، أضِف المكتبة إلى مشروعك مع أي مكتبات متوافقة. استخدِم الجدول أدناه لتحديد المكتبات التي تريد إضافتها.

العناصر

الاسم

وظيفته

العنصر

مكتبة التشغيل لنظام Navigation 3

واجهة برمجة التطبيقات Core Navigation 3 API تشمل NavEntry, EntryProvider وخط DSL المرتبط به.

androidx.navigation3:navigation3-runtime

مكتبة واجهة مستخدم Navigation 3

يوفّر فئات لعرض المحتوى، بما في ذلك NavDisplay وScene.

androidx.navigation3:navigation3-ui

مراحل نشاط ViewModel في Navigation 3

يسمح بتحديد نطاق ViewModels على الإدخالات في الحزمة الخلفية.

androidx.lifecycle:lifecycle-viewmodel-navigation3

متوفّرة في إصدارات النُسخ المصغّرة

تنسيقات Material 3 التكيُّفية لنظام Navigation 3

يوفّر تنسيقات قابلة للتكيّف (SceneStrategies وScenes وتعريفات البيانات الوصفية) لاستخدامها مع NavDisplay.

androidx.compose.material3.adaptive:adaptive-navigation3

متوفّرة في إصدارات النُسخ المصغّرة

KotlinX Serialization

يسمح بتسلسل مفاتيح التنقّل.

المكوّن الإضافي: 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/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)
}