Comenzar

Para comenzar a usar Navigation 3, agrega la biblioteca a tu proyecto junto con las bibliotecas compatibles. Usa la siguiente tabla para decidir qué bibliotecas agregar.

Artefactos

Nombre

Qué hace

Artefacto

Biblioteca del entorno de ejecución de Navigation 3

API de Core Navigation 3. Incluye NavEntry, EntryProvider y el DSL asociado.

androidx.navigation3:navigation3-runtime

Biblioteca de la IU de Navigation 3

Proporciona clases para mostrar contenido, incluidas NavDisplay y Scene.

androidx.navigation3:navigation3-ui

Ciclo de vida de ViewModel para Navigation 3

Permite que los objetos ViewModel se definan en el ámbito de las entradas de la pila de actividades.

androidx.lifecycle:lifecycle-viewmodel-navigation3

Diseños adaptables de Material 3 para Navigation 3

Proporciona diseños adaptables (SceneStrategies, escenas y definiciones de metadatos) para usar con NavDisplay.

androidx.compose.material3.adaptive:adaptive-navigation3

Disponible en compilaciones de instantáneas

Serialización de KotlinX

Permite que se serialicen las teclas de navegación.

Complemento: org.jetbrains.kotlin.plugin.serialization

Biblioteca:

org.jetbrains.kotlinx:kotlinx-serialization-core

Configuración del proyecto

Para agregar la biblioteca de Navigation 3 a tu proyecto existente, agrega lo siguiente a tu libs.versions.toml:

[versions]
nav3Core = "1.0.0-alpha01"
lifecycleViewmodelNav3 = "1.0.0-alpha01"
kotlinSerialization = "2.1.21"
kotlinxSerializationCore = "1.8.1"
material3AdaptiveNav3 = "1.0.0-SNAPSHOT"

[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" }

# Note: The Material3 adaptive layouts library for Navigation 3 is currently
# only available in snapshot builds. Follow the instructions at androidx.dev to
# add the snapshot builds repository to your project.
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"}

Además, actualiza el SDK de compilación a la versión 36 o una posterior: 

[versions]
compileSdk = "36"

Agrega lo siguiente al archivo de compilación app/build.gradle.kts de tu app:

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