Rozpocznij

Aby rozpocząć korzystanie z biblioteki Nawigacja 3, dodaj ją do projektu wraz z wspierającymi ją bibliotekami. Z tabeli poniżej dowiesz się, które biblioteki dodać.

Artefakty

Nazwa

Co to jest

Artefakt

Nawigacja 3 Biblioteka czasu wykonywania

Interfejs Core Navigation 3 API. Obejmuje NavEntry, EntryProvider i powiązaną usługę DSL.

androidx.navigation3:navigation3-runtime

Biblioteka UI nawigacji 3

Udostępnia klasy do wyświetlania treści, w tym NavDisplay i Scene.

androidx.navigation3:navigation3-ui

Cykl życia ViewModel w ramach nawigacji 3

Umożliwia ograniczenie zakresu działania ViewModels do wpisów w składce poprzednich elementów.

androidx.lifecycle:lifecycle-viewmodel-navigation3

Materiał 3 – układy adaptacyjne dla nawigacji 3

Udostępnia elastyczne układy (strategie scen, definicje scen i metadanych) do użycia w ramach NavDisplay.

androidx.compose.material3.adaptive:adaptive-navigation3

Dostępne w wersjach podglądowych

KotlinX Serialization

Umożliwia serializację klawiszy nawigacyjnych.

Wtyczka: org.jetbrains.kotlin.plugin.serialization

Biblioteka:

org.jetbrains.kotlinx:kotlinx-serialization-core

Konfiguracja projektu

Aby dodać bibliotekę Nawigacja 3 do istniejącego projektu, dodaj te elementy do pliku 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"}

Zaktualizuj też kompilowany pakiet SDK do wersji 36 lub nowszej: 

[versions]
compileSdk = "36"

Dodaj do pliku kompilacji aplikacji 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)
}