Refactor Interests to ListDetailScene

Author: claraf3

app/build.gradle.kts

@@ -88,24 +88,24 @@ dependencies {
     implementation(projects.core.designsystem)
     implementation(projects.core.data)
     implementation(projects.core.model)
-    implementation(projects.core.navigation)
     implementation(projects.core.analytics)
     implementation(projects.core.navigation)
     implementation(projects.sync.work)
 
     implementation(libs.androidx.activity.compose)
     implementation(libs.androidx.compose.material3)
-    implementation(libs.androidx.navigation3.runtime)
     implementation(libs.androidx.navigation3.ui)
     implementation(libs.androidx.compose.material3.adaptive)
     implementation(libs.androidx.compose.material3.adaptive.layout)
     implementation(libs.androidx.compose.material3.adaptive.navigation)
+    implementation(libs.androidx.compose.material3.adaptive.navigation3)
     implementation(libs.androidx.compose.material3.windowSizeClass)
     implementation(libs.androidx.compose.runtime.tracing)
     implementation(libs.androidx.core.ktx)
     implementation(libs.androidx.core.splashscreen)
     implementation(libs.androidx.hilt.navigation.compose)
     implementation(libs.androidx.lifecycle.runtimeCompose)
+    implementation(libs.androidx.lifecycle.viewModel.navigation3)
     implementation(libs.androidx.navigation.compose)
     implementation(libs.androidx.profileinstaller)
     implementation(libs.androidx.tracing.ktx)

app/src/main/kotlin/com/google/samples/apps/nowinandroid/MainActivity.kt

@@ -43,6 +43,7 @@ import com.google.samples.apps.nowinandroid.core.data.util.TimeZoneMonitor
 import com.google.samples.apps.nowinandroid.core.designsystem.theme.NiaTheme
 import com.google.samples.apps.nowinandroid.core.ui.LocalTimeZone
 import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStack
+import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStackKey
 import com.google.samples.apps.nowinandroid.ui.NiaApp
 import com.google.samples.apps.nowinandroid.ui.rememberNiaAppState
 import com.google.samples.apps.nowinandroid.util.isSystemInDarkTheme
@@ -80,7 +81,7 @@ class MainActivity : ComponentActivity() {
     lateinit var niaBackStack: NiaBackStack
 
     @Inject
-    lateinit var entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<Any>.() -> Unit>
+    lateinit var entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<NiaBackStackKey>.() -> Unit>
 
     override fun onCreate(savedInstanceState: Bundle?) {
         val splashScreen = installSplashScreen()

app/src/main/kotlin/com/google/samples/apps/nowinandroid/di/BackStackProvider.kt

@@ -26,7 +26,7 @@ import dagger.hilt.components.SingletonComponent
 
 @Module
 @InstallIn(SingletonComponent::class)
-object NiaAppNavigation {
+object BackStackProvider {
     @Provides
     @Singleton
     fun provideNiaBackStack(): NiaBackStack =

app/src/main/kotlin/com/google/samples/apps/nowinandroid/navigation/NiaNavDisplay.kt

@@ -16,23 +16,36 @@
 
 package com.google.samples.apps.nowinandroid.navigation
 
+import androidx.compose.material3.adaptive.ExperimentalMaterial3AdaptiveApi
+import androidx.compose.material3.adaptive.navigation3.rememberListDetailSceneStrategy
 import androidx.compose.runtime.Composable
 import androidx.compose.runtime.compositionLocalOf
-import androidx.compose.runtime.snapshots.SnapshotStateList
+import androidx.lifecycle.viewmodel.navigation3.rememberViewModelStoreNavEntryDecorator
 import androidx.navigation3.runtime.EntryProviderBuilder
-import androidx.navigation3.runtime.NavEntryDecorator
 import androidx.navigation3.runtime.entryProvider
+import androidx.navigation3.runtime.rememberSavedStateNavEntryDecorator
 import androidx.navigation3.ui.NavDisplay
+import androidx.navigation3.ui.rememberSceneSetupNavEntryDecorator
 import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStack
+import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStackKey
 
+@OptIn(ExperimentalMaterial3AdaptiveApi::class)
 @Composable
 fun NiaNavDisplay(
     niaBackStack: NiaBackStack,
-    entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<Any>.() -> Unit>,
+    entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<NiaBackStackKey>.() -> Unit>,
 ) {
+    val listDetailStrategy = rememberListDetailSceneStrategy<NiaBackStackKey>()
+
     NavDisplay(
         backStack = niaBackStack.backStack,
+        sceneStrategy = listDetailStrategy,
         onBack = { niaBackStack.removeLast() },
+        entryDecorators = listOf(
+            rememberSceneSetupNavEntryDecorator(),
+            rememberSavedStateNavEntryDecorator(),
+            rememberViewModelStoreNavEntryDecorator(),
+        ),
         entryProvider = entryProvider {
             entryProviderBuilders.forEach { builder ->
                 builder()

app/src/main/kotlin/com/google/samples/apps/nowinandroid/navigation/NiaNavHost.kt

@@ -20,7 +20,7 @@ import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
 import androidx.navigation.compose.NavHost
 import com.google.samples.apps.nowinandroid.feature.bookmarks.api.navigation.bookmarksScreen
-import com.google.samples.apps.nowinandroid.feature.foryou.api.navigation.ForYouBaseRoute
+import com.google.samples.apps.nowinandroid.feature.foryou.api.navigation.ForYouRoute
 import com.google.samples.apps.nowinandroid.feature.foryou.api.navigation.forYouSection
 import com.google.samples.apps.nowinandroid.feature.interests.api.navigation.navigateToInterests
 import com.google.samples.apps.nowinandroid.feature.search.api.navigation.searchScreen
@@ -46,7 +46,7 @@ fun NiaNavHost(
     val navController = appState.navController
     NavHost(
         navController = navController,
-        startDestination = ForYouBaseRoute,
+        startDestination = ForYouRoute,
         modifier = modifier,
     ) {
         forYouSection(

app/src/main/kotlin/com/google/samples/apps/nowinandroid/navigation/TopLevelDestination.kt

@@ -20,8 +20,8 @@ import androidx.annotation.StringRes
 import androidx.compose.ui.graphics.vector.ImageVector
 import com.google.samples.apps.nowinandroid.R
 import com.google.samples.apps.nowinandroid.core.designsystem.icon.NiaIcons
+import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStackKey
 import com.google.samples.apps.nowinandroid.feature.bookmarks.api.navigation.BookmarksRoute
-import com.google.samples.apps.nowinandroid.feature.foryou.api.navigation.ForYouBaseRoute
 import com.google.samples.apps.nowinandroid.feature.foryou.api.navigation.ForYouRoute
 import com.google.samples.apps.nowinandroid.feature.interests.api.navigation.InterestsRoute
 import kotlin.reflect.KClass
@@ -49,17 +49,15 @@ enum class TopLevelDestination(
     @StringRes val iconTextId: Int,
     @StringRes val titleTextId: Int,
     val route: KClass<*>,
-    val baseRoute: KClass<*> = route,
-    val key: Any
+    val key: NiaBackStackKey
 ) {
     FOR_YOU(
         selectedIcon = NiaIcons.Upcoming,
         unselectedIcon = NiaIcons.UpcomingBorder,
         iconTextId = forYouR.string.feature_foryou_api_title,
         titleTextId = R.string.app_name,
         route = ForYouRoute::class,
-        baseRoute = ForYouBaseRoute::class,
-        key = ForYouBaseRoute
+        key = ForYouRoute
     ),
     BOOKMARKS(
         selectedIcon = NiaIcons.Bookmarks,
@@ -78,3 +76,5 @@ enum class TopLevelDestination(
         key = InterestsRoute(null)
     ),
 }
+
+internal val TopLevelDestinations = TopLevelDestination.entries.associateBy { dest -> dest.key }

app/src/main/kotlin/com/google/samples/apps/nowinandroid/ui/NiaApp.kt

@@ -71,7 +71,9 @@ import com.google.samples.apps.nowinandroid.core.designsystem.component.NiaTopAp
 import com.google.samples.apps.nowinandroid.core.designsystem.icon.NiaIcons
 import com.google.samples.apps.nowinandroid.core.designsystem.theme.GradientColors
 import com.google.samples.apps.nowinandroid.core.designsystem.theme.LocalGradientColors
+import com.google.samples.apps.nowinandroid.core.navigation.NiaBackStackKey
 import com.google.samples.apps.nowinandroid.feature.bookmarks.impl.navigation.LocalSnackbarHostState
+import com.google.samples.apps.nowinandroid.feature.search.api.navigation.navigateToSearch
 import com.google.samples.apps.nowinandroid.feature.settings.api.SettingsDialog
 import com.google.samples.apps.nowinandroid.navigation.NiaNavDisplay
 import com.google.samples.apps.nowinandroid.navigation.TopLevelDestination
@@ -81,7 +83,7 @@ import com.google.samples.apps.nowinandroid.feature.settings.api.R as settingsR
 @Composable
 fun NiaApp(
     appState: NiaAppState,
-    entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<Any>.() -> Unit>,
+    entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<NiaBackStackKey>.() -> Unit>,
     modifier: Modifier = Modifier,
     windowAdaptiveInfo: WindowAdaptiveInfo = currentWindowAdaptiveInfo(),
 ) {
@@ -132,7 +134,7 @@ fun NiaApp(
 )
 internal fun NiaApp(
     appState: NiaAppState,
-    entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<Any>.() -> Unit>,
+    entryProviderBuilders: Set<@JvmSuppressWildcards EntryProviderBuilder<NiaBackStackKey>.() -> Unit>,
     showSettingsDialog: Boolean,
     onSettingsDismissed: () -> Unit,
     onTopAppBarActionClick: () -> Unit,
@@ -141,7 +143,7 @@ internal fun NiaApp(
 ) {
     val unreadDestinations by appState.topLevelDestinationsWithUnreadResources
         .collectAsStateWithLifecycle()
-    val currentTopLevelKey = appState.currentTopLevelDestination
+    val currentTopLevelKey = appState.currentTopLevelDestination!!.key
 
 
     if (showSettingsDialog) {
@@ -156,10 +158,7 @@ internal fun NiaApp(
         navigationSuiteItems = {
             appState.topLevelDestinations.forEach { destination ->
                 val hasUnread = unreadDestinations.contains(destination)
-//                val selected = currentDestination
-//                    .isRouteInHierarchy(destination.baseRoute)
                 val selected = destination.key == currentTopLevelKey
-                println("cfok destination:$destination, currentDest:$currentTopLevelKey")
                 item(
                     selected = selected,
                     onClick = { appState.navigateToTopLevelDestination(destination) },
@@ -233,7 +232,7 @@ internal fun NiaApp(
                             containerColor = Color.Transparent,
                         ),
                         onActionClick = { onTopAppBarActionClick() },
-                        onNavigationClick = { appState.navigateToSearchNav3() },
+                        onNavigationClick = { appState.niaBackStack.navigateToSearch() },
                     )
                 }
 

app/src/main/kotlin/com/google/samples/apps/nowinandroid/ui/NiaAppState.kt

@@ -35,6 +35,7 @@ import com.google.samples.apps.nowinandroid.navigation.TopLevelDestination
 import com.google.samples.apps.nowinandroid.navigation.TopLevelDestination.BOOKMARKS
 import com.google.samples.apps.nowinandroid.navigation.TopLevelDestination.FOR_YOU
 import com.google.samples.apps.nowinandroid.navigation.TopLevelDestination.INTERESTS
+import com.google.samples.apps.nowinandroid.navigation.TopLevelDestinations
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.flow.SharingStarted
 import kotlinx.coroutines.flow.StateFlow
@@ -98,12 +99,7 @@ class NiaAppState(
 //        }
 
     val currentTopLevelDestination: TopLevelDestination?
-        @Composable get() {
-            return TopLevelDestination.entries.firstOrNull { topLevelDestination ->
-                topLevelDestination.key == niaBackStack.currentTopLevelKey
-//                currentDestination?.hasRoute(route = topLevelDestination.route) == true
-            }
-        }
+        @Composable get() = TopLevelDestinations[niaBackStack.currentTopLevelKey]
 
     val isOffline = networkMonitor.isOnline
         .map(Boolean::not)
@@ -178,9 +174,6 @@ class NiaAppState(
     }
 
     fun navigateToSearch() = navController.navigateToSearch()
-    fun navigateToSearchNav3() = niaBackStack.navigateToSearch(
-        onInterestsClick = { navigateToTopLevelDestination(INTERESTS) }
-    )
 }
 
 /**

core/navigation/build.gradle.kts

@@ -4,5 +4,5 @@ plugins {
 }
 
 dependencies {
-    implementation(libs.androidx.navigation3.runtime)
+    api(libs.androidx.navigation3.runtime)
 }

core/navigation/src/main/kotlin/com/google/samples/apps/nowinandroid/core/navigation/NiaBackStack.kt

@@ -16,7 +16,6 @@
 
 package com.google.samples.apps.nowinandroid.core.navigation
 
-import androidx.compose.runtime.Composable
 import androidx.compose.runtime.getValue
 import androidx.compose.runtime.mutableStateListOf
 import androidx.compose.runtime.mutableStateOf
@@ -26,29 +25,29 @@ import javax.inject.Inject
 import kotlin.collections.remove
 
 class NiaBackStack @Inject constructor(
-    startKey: Any,
+    startKey: NiaBackStackKey,
 ) {
     val backStack = mutableStateListOf(startKey)
 
     // Maintain a stack for each top level route
-    private var topLevelStacks : LinkedHashMap<Any, SnapshotStateList<Any>> = linkedMapOf(
+    private var topLevelStacks : LinkedHashMap<NiaBackStackKey, SnapshotStateList<NiaBackStackKey>> = linkedMapOf(
         startKey to mutableStateListOf(startKey)
     )
 
     // Expose the current top level route for consumers
     var currentTopLevelKey by mutableStateOf(startKey)
         private set
 
-    internal val currentKey: Any
-        @Composable get() = topLevelStacks[currentTopLevelKey]!!.last()
+    internal val currentKey: NiaBackStackKey
+        get() = topLevelStacks[currentTopLevelKey]!!.last()
 
     private fun updateBackStack() =
         backStack.apply {
             clear()
             addAll(topLevelStacks.flatMap { it.value })
         }
 
-    fun navigateToTopLevelDestination(key: Any){
+    fun navigateToTopLevelDestination(key: NiaBackStackKey){
         // If the top level doesn't exist, add it
         if (topLevelStacks[key] == null){
             topLevelStacks.put(key, mutableStateListOf(key))
@@ -60,14 +59,16 @@ class NiaBackStack @Inject constructor(
                 }
             }
         }
+
         currentTopLevelKey = key
         updateBackStack()
     }
 
-    fun navigate(key: Any){
-        println("cfok navigate $key")
-        topLevelStacks[currentTopLevelKey]?.add(key)
-        updateBackStack()
+    fun navigate(key: NiaBackStackKey){
+        if (backStack.lastOrNull() != key) {
+            topLevelStacks[currentTopLevelKey]?.add(key)
+            updateBackStack()
+        }
     }
 
     fun removeLast(){
@@ -77,5 +78,6 @@ class NiaBackStack @Inject constructor(
         currentTopLevelKey = topLevelStacks.keys.last()
         updateBackStack()
     }
+}
 
-}
+interface NiaBackStackKey