Per iniziare

Per iniziare a utilizzare Navigation 3, aggiungi la libreria al progetto insieme a eventuali librerie di supporto. Utilizza la tabella di seguito per decidere quali librerie aggiungere.

Elementi

Nome

Che cosa fa

Artefatto

Libreria di runtime di Navigation 3

API Core Navigation 3. Include NavEntry, EntryProvider e il DSL associato.

androidx.navigation3:navigation3-runtime

Libreria UI di Navigation 3

Fornisce classi per visualizzare i contenuti, inclusi NavDisplay e Scene.

androidx.navigation3:navigation3-ui

Ciclo di vita di ViewModel per Navigation 3

Consente di limitare l'ambito dei ViewModel alle voci nello stack precedente.

androidx.lifecycle:lifecycle-viewmodel-navigation3

Disponibile nelle build snapshot

Layout adattivi di Material 3 per Navigazione 3

Fornisce layout adattabili (SceneStrategies, Scene e definizioni dei metadati) da utilizzare con NavDisplay.

androidx.compose.material3.adaptive:adaptive-navigation3

Disponibile nelle build snapshot

Serializzazione KotlinX

Consente la serializzazione delle chiavi di navigazione.

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

Biblioteche:

org.jetbrains.kotlinx:kotlinx-serialization-core

org.jetbrains.kotlinx:kotlinx-serialization-json

Configurazione del progetto

Per aggiungere la libreria Navigation 3 al progetto esistente, aggiungi quanto segue al 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"}

Aggiungi quanto segue al file di build dell'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)
    implementation(libs.androidx.lifecycle.viewmodel.navigation3)
    implementation(libs.androidx.material3.navigation3)
    implementation(libs.kotlinx.serialization.core)
    implementation(libs.kotlinx.serialization.json)
}