Premiers pas

Pour commencer à utiliser Navigation 3, ajoutez la bibliothèque à votre projet, ainsi que les bibliothèques associées. Utilisez le tableau ci-dessous pour choisir les bibliothèques à ajouter.

Artefacts

Nom

Fonctionnement

Artefact

Bibliothèque d'exécution Navigation 3

API Core Navigation 3 Inclut NavEntry, EntryProvider et le DSL associé.

androidx.navigation3:navigation3-runtime

Bibliothèque d'UI Navigation 3

Fournit des classes pour afficher du contenu, y compris NavDisplay et Scene.

androidx.navigation3:navigation3-ui

Cycle de vie de ViewModel pour Navigation 3

Permet de limiter le champ d'application des ViewModels aux entrées de la pile "Retour".

androidx.lifecycle:lifecycle-viewmodel-navigation3

Disponible dans les builds instantanés

Mises en page adaptatives Material 3 pour Navigation 3

Fournit des mises en page adaptatives (SceneStrategies, Scenes et définitions de métadonnées) à utiliser avec NavDisplay.

androidx.compose.material3.adaptive:adaptive-navigation3

Disponible dans les builds instantanés

Sérialisation KotlinX

Permet de sérialiser les touches de navigation.

Plug-in: org.jetbrains.kotlin.plugin.serialization

Bibliothèques:

org.jetbrains.kotlinx:kotlinx-serialization-core

org.jetbrains.kotlinx:kotlinx-serialization-json

Configuration du projet

Pour ajouter la bibliothèque Navigation 3 à votre projet existant, ajoutez ce qui suit à votre 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"}

Ajoutez le code suivant au fichier de compilation app/build.gradle.kts de votre application:

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)
}