Merge pull request #316 from android/dt/type-safe-nav-2

Snippet updates for type safe navigation APIs

Author: dturner

build.gradle.kts

@@ -8,6 +8,7 @@ plugins {
     alias(libs.plugins.kapt) apply false
     alias(libs.plugins.hilt) apply false
     alias(libs.plugins.kotlin.parcelize) apply false
+    alias(libs.plugins.kotlin.serialization) apply false
 }
 
 apply("${project.rootDir}/buildscripts/toml-updater-config.gradle")

compose/snippets/build.gradle.kts

@@ -20,6 +20,7 @@ plugins {
     alias(libs.plugins.kapt)
     alias(libs.plugins.hilt)
     alias(libs.plugins.kotlin.parcelize)
+    alias(libs.plugins.kotlin.serialization)
 }
 
 android {
@@ -83,7 +84,6 @@ dependencies {
     implementation(composeBom)
     androidTestImplementation(composeBom)
 
-    implementation(libs.androidx.compose.foundation)
     implementation(libs.androidx.compose.ui)
     implementation(libs.androidx.compose.ui.util)
     implementation(libs.androidx.compose.ui.graphics)
@@ -139,6 +139,7 @@ dependencies {
     implementation(libs.androidx.navigation.compose)
     implementation(libs.hilt.android)
     implementation(libs.androidx.hilt.navigation.compose)
+    implementation(libs.kotlinx.serialization.json)
 
     implementation(libs.androidx.recyclerview)
 

compose/snippets/src/main/java/com/example/compose/snippets/interop/MigrationCommonScenariosSnippets.kt

@@ -64,10 +64,12 @@ import androidx.navigation.NavHostController
 import androidx.navigation.compose.NavHost
 import androidx.navigation.compose.composable
 import androidx.navigation.compose.rememberNavController
+import androidx.navigation.toRoute
 import androidx.recyclerview.widget.DividerItemDecoration
 import androidx.recyclerview.widget.LinearLayoutManager
 import androidx.recyclerview.widget.RecyclerView
 import kotlinx.coroutines.launch
+import kotlinx.serialization.Serializable
 
 class RVActivity : ComponentActivity() {
     private lateinit var composeView: ComposeView
@@ -141,6 +143,13 @@ class SampleActivity : ComponentActivity() {
 }
 // [END android_compose_interop_migration_common_scenarios_navigation_step_2]
 
+// [START android_compose_interop_migration_common_scenarios_navigation_step_2_1]
+@Serializable data object First
+@Serializable data class Second(val id: String)
+@Serializable data object Third
+
+// [END android_compose_interop_migration_common_scenarios_navigation_step_2_1]
+
 private object MigrationCommonScenariosNavigationStep3 {
     // [START android_compose_interop_migration_common_scenarios_navigation_step_3]
     @Composable
@@ -164,7 +173,7 @@ private object MigrationCommonScenariosNavigationStep4 {
     fun SampleNavHost(
         navController: NavHostController
     ) {
-        NavHost(navController = navController, startDestination = "first") {
+        NavHost(navController = navController, startDestination = First) {
             // ...
         }
     }
@@ -191,11 +200,11 @@ class FirstFragment : Fragment() {
 fun SampleNavHost(
     navController: NavHostController
 ) {
-    NavHost(navController = navController, startDestination = "first") {
-        composable("first") {
+    NavHost(navController = navController, startDestination = First) {
+        composable<First> {
             FirstScreen(/* ... */) // EXTRACT TO HERE
         }
-        composable("second") {
+        composable<Second> {
             SecondScreen(/* ... */)
         }
         // ...
@@ -220,20 +229,22 @@ private object MigrationCommonScenariosNavigationStep7 {
     fun SampleNavHost(
         navController: NavHostController
     ) {
-        NavHost(navController = navController, startDestination = "first") {
-            composable("first") {
+        NavHost(navController = navController, startDestination = First) {
+            composable<First> {
                 FirstScreen(
                     onButtonClick = {
                         // findNavController().navigate(firstScreenToSecondScreenAction)
-                        navController.navigate("second_screen_route")
+                        navController.navigate(Second(id = "ABC"))
                     }
                 )
             }
-            composable("second") {
+            composable<Second> { backStackEntry ->
+                val secondRoute = backStackEntry.toRoute<Second>()
                 SecondScreen(
+                    id = secondRoute.id,
                     onIconClick = {
                         // findNavController().navigate(secondScreenToThirdScreenAction)
-                        navController.navigate("third_screen_route")
+                        navController.navigate(Third)
                     }
                 )
             }
@@ -410,6 +421,7 @@ fun SampleApp() {
 
 @Composable
 fun SecondScreen(
+    id: String = "<no ID supplied>",
     onIconClick: () -> Unit = {},
 ) {
 }

gradle/libs.versions.toml

@@ -14,7 +14,7 @@ androidx-fragment-ktx = "1.6.2"
 androidx-glance-appwidget = "1.0.0"
 androidx-lifecycle-compose = "2.8.0-rc01"
 androidx-lifecycle-runtime-compose = "2.8.0-rc01"
-androidx-navigation = "2.7.7"
+androidx-navigation = "2.8.0-rc01"
 androidx-paging = "3.2.1"
 androidx-test = "1.5.0"
 androidx-test-espresso = "3.5.1"
@@ -34,6 +34,7 @@ horologist = "0.5.24"
 junit = "4.13.2"
 # @pin Update in conjuction with Compose Compiler
 kotlin = "1.9.20"
+kotlinxSerializationJson = "1.6.3"
 ksp = "1.8.0-1.0.9"
 maps-compose = "4.3.2"
 material = "1.4.0-beta01"
@@ -120,6 +121,7 @@ junit = { module = "junit:junit", version.ref = "junit" }
 kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib-jdk8", version.ref = "kotlin" }
 kotlinx-coroutines-android = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-android", version.ref = "coroutines" }
 kotlinx-coroutines-test = { module = "org.jetbrains.kotlinx:kotlinx-coroutines-test", version.ref = "coroutines" }
+kotlinx-serialization-json = { group = "org.jetbrains.kotlinx", name = "kotlinx-serialization-json", version.ref = "kotlinxSerializationJson" }
 androidx-media3-common = { group = "androidx.media3", name = "media3-common", version.ref = "media3" }
 androidx-media3-exoplayer = { group = "androidx.media3", name = "media3-exoplayer", version.ref = "media3" }
 play-services-wearable = { module = "com.google.android.gms:play-services-wearable", version.ref = "playServicesWearable" }
@@ -134,4 +136,5 @@ hilt = { id = "com.google.dagger.hilt.android", version.ref = "hilt" }
 kapt = { id = "org.jetbrains.kotlin.kapt", version.ref = "kotlin" }
 kotlin-android = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" }
 kotlin-parcelize = { id = "org.jetbrains.kotlin.plugin.parcelize", version.ref = "kotlin" }
+kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
 version-catalog-update = { id = "nl.littlerobots.version-catalog-update", version.ref = "version-catalog-update" }