Начать

Чтобы начать работу с Navigation 3, добавьте библиотеку в свой проект вместе с любыми поддерживающими библиотеками. Используйте таблицу ниже, чтобы решить, какие библиотеки добавить.

Артефакты

Имя

Что он делает

Артефакт

Библиотека времени выполнения Navigation 3

API Core Navigation 3. Включает NavEntry, EntryProvider и связанный DSL.

androidx.navigation3:navigation3-время выполнения

Библиотека пользовательского интерфейса Navigation 3

Предоставляет классы для отображения контента, включая NavDisplay и Scene .

androidx.navigation3:navigation3-ui

Жизненный цикл ViewModel для навигации 3

Позволяет ограничить ViewModels записями в стеке переходов.

androidx.lifecycle:lifecycle-viewmodel-navigation3

Доступно в сборках снимков

Адаптивные макеты Material 3 для Navigation 3

Предоставляет адаптивные макеты (SceneStrategies, Scenes и определения метаданных) для использования с NavDisplay.

androidx.compose.material3.adaptive:адаптивная-навигация3

Доступно в сборках снимков

Сериализация KotlinX

Позволяет сериализовать навигационные клавиши.

Плагин: org.jetbrains.kotlin.plugin.serialization

Библиотеки:

org.jetbrains.kotlinx:kotlinx-сериализация-ядро

org.jetbrains.kotlinx:kotlinx-сериализация-json

Настройка проекта

Чтобы добавить библиотеку Navigation 3 в существующий проект, добавьте следующее в файл 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"}

Добавьте следующее в файл сборки приложения 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)
}