Premiers pas

Pour commencer à utiliser Navigation 3, ajoutez la bibliothèque à votre projet ainsi que toutes les bibliothèques associées. Utilisez le tableau ci-dessous pour déterminer 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 ViewModel pour Navigation 3

Permet de limiter les ViewModels aux entrées de la pile "Retour".

androidx.lifecycle:lifecycle-viewmodel-navigation3

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 versions instantanées

Sérialisation KotlinX

Permet de sérialiser les clés de navigation.

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

Bibliothèque :

org.jetbrains.kotlinx:kotlinx-serialization-core

Configuration du projet

Pour ajouter la bibliothèque Navigation 3 à votre projet existant, ajoutez les éléments suivants à votre 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"}

Mettez également à jour votre SDK de compilation vers la version 36 ou ultérieure : 

[versions]
compileSdk = "36"

Ajoutez le code suivant à votre fichier de compilation 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)
}