Começar

Para começar a usar o Navigation 3, adicione a biblioteca ao seu projeto com as bibliotecas de suporte. Use a tabela abaixo para decidir quais bibliotecas adicionar.

Artefatos

Nome

O que ele faz

Artefato

Biblioteca de ambiente de execução do Navigation 3

API Core Navigation 3. Inclui NavEntry, EntryProvider e a DSL associada.

androidx.navigation3:navigation3-runtime

Biblioteca de interface Navigation 3

Fornece classes para exibir conteúdo, incluindo NavDisplay e Scene.

androidx.navigation3:navigation3-ui

Ciclo de vida do ViewModel para navegação 3

Permite que os ViewModels sejam delimitados a entradas na backstack.

androidx.lifecycle:lifecycle-viewmodel-navigation3

Layouts adaptáveis do Material 3 para a Navegação 3

Fornece layouts adaptáveis (SceneStrategies, Scenes e definições de metadados) para uso com o NavDisplay.

androidx.compose.material3.adaptive:adaptive-navigation3

Disponível em builds de snapshots

Serialização do KotlinX

Permite que as teclas de navegação sejam serializadas.

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

Biblioteca:

org.jetbrains.kotlinx:kotlinx-serialization-core

Configuração do projeto

Para adicionar a biblioteca Navigation 3 ao projeto atual, adicione o seguinte ao 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"}

Além disso, atualize o SDK de compilação para a versão 36 ou mais recente: 

[versions]
compileSdk = "36"

Adicione o seguinte ao arquivo de build do 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)
}