시작하기

Navigation 3을 시작하려면 지원 라이브러리와 함께 라이브러리를 프로젝트에 추가합니다. 아래 표를 사용하여 추가할 라이브러리를 결정합니다.

아티팩트

이름

기능

아티팩트

Navigation 3 런타임 라이브러리

Core Navigation 3 API NavEntry, EntryProvider 및 관련 DSL을 포함합니다.

androidx.navigation3:navigation3-runtime

Navigation 3 UI 라이브러리

NavDisplay 및 Scene를 비롯하여 콘텐츠를 표시하는 클래스를 제공합니다.

androidx.navigation3:navigation3-ui

탐색 3의 ViewModel 수명 주기

ViewModel의 범위를 백 스택의 항목으로 지정할 수 있습니다.

androidx.lifecycle:lifecycle-viewmodel-navigation3

Navigation 3용 Material 3 적응형 레이아웃

NavDisplay와 함께 사용할 수 있는 적응형 레이아웃 (SceneStrategies, Scenes, 메타데이터 정의)을 제공합니다.

androidx.compose.material3.adaptive:adaptive-navigation3

스냅샷 빌드에서 사용 가능

KotlinX 직렬화

탐색 키를 직렬화할 수 있습니다.

플러그인: org.jetbrains.kotlin.plugin.serialization

보관함:

org.jetbrains.kotlinx:kotlinx-serialization-core

프로젝트 설정

기존 프로젝트에 Navigation 3 라이브러리를 추가하려면 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"}

또한 컴파일 SDK를 36 이상으로 업데이트합니다. 

[versions]
compileSdk = "36"

앱 빌드 파일 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)
}