Address feedback

- Rename "Route" composables to be the stateful version of the "Screen" composables (e.g. PostRoute -> PostScreen)
- Refactor Navigator to decouple it from the individual features
- Refactor AppDrawer and AppNavRail to take a list of NavigationItem
- Colocate deep link patterns with their nav keys

Author: bsagmoe

JetNews/app/src/main/java/com/example/jetnews/deeplink/JetnewsDeeplinks.kt

@@ -17,31 +17,14 @@
 package com.example.jetnews.deeplink
 
 import android.net.Uri
-import androidx.core.net.toUri
 import androidx.navigation3.runtime.NavKey
 import com.example.jetnews.deeplink.util.DeepLinkMatcher
-import com.example.jetnews.deeplink.util.DeepLinkPattern
 import com.example.jetnews.deeplink.util.DeepLinkRequest
 import com.example.jetnews.deeplink.util.KeyDecoder
-import com.example.jetnews.ui.home.HomeKey
-import com.example.jetnews.ui.interests.InterestsKey
+import com.example.jetnews.ui.home.HomeDeepLinkPattern
+import com.example.jetnews.ui.interests.InterestsDeepLinkPattern
 import com.example.jetnews.ui.navigation.DeepLinkKey
-import com.example.jetnews.ui.post.PostKey
-
-val HomeDeepLinkPattern = DeepLinkPattern(
-    HomeKey.serializer(),
-    uriPattern = "https://developer.android.com/jetnews".toUri(),
-)
-
-val PostDeepLinkPattern = DeepLinkPattern(
-    PostKey.serializer(),
-    uriPattern = "https://developer.android.com/jetnews/posts/{postId}".toUri(),
-)
-
-val InterestsDeepLinkPattern = DeepLinkPattern(
-    InterestsKey.serializer(),
-    uriPattern = "https://developer.android.com/jetnews/interests".toUri(),
-)
+import com.example.jetnews.ui.post.PostDeepLinkPattern
 
 val JetnewsDeepLinkPatterns = listOf(HomeDeepLinkPattern, PostDeepLinkPattern, InterestsDeepLinkPattern)
 

JetNews/app/src/main/java/com/example/jetnews/ui/AppDrawer.kt

@@ -31,6 +31,7 @@ import androidx.compose.material3.NavigationDrawerItemDefaults
 import androidx.compose.material3.Text
 import androidx.compose.material3.rememberDrawerState
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.key
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.res.stringResource
@@ -39,15 +40,16 @@ import androidx.compose.ui.unit.dp
 import androidx.navigation3.runtime.NavKey
 import com.example.jetnews.R
 import com.example.jetnews.ui.home.HomeKey
-import com.example.jetnews.ui.interests.InterestsKey
+import com.example.jetnews.ui.navigation.NavigationItem
+import com.example.jetnews.ui.navigation.TOP_LEVEL_ROUTES
 import com.example.jetnews.ui.theme.JetnewsTheme
 
 @Composable
 fun AppDrawer(
     drawerState: DrawerState,
-    currentRoute: NavKey,
-    navigateToHome: () -> Unit,
-    navigateToInterests: () -> Unit,
+    currentTopLevelRoute: NavKey,
+    navigate: (NavKey) -> Unit,
+    navigationItems: List<NavigationItem>,
     closeDrawer: () -> Unit,
     modifier: Modifier = Modifier,
 ) {
@@ -58,26 +60,20 @@ fun AppDrawer(
         JetNewsLogo(
             modifier = Modifier.padding(horizontal = 28.dp, vertical = 24.dp),
         )
-        NavigationDrawerItem(
-            label = { Text(stringResource(id = R.string.home_title)) },
-            icon = { Icon(painterResource(R.drawable.ic_home), null) },
-            selected = currentRoute is HomeKey,
-            onClick = {
-                navigateToHome()
-                closeDrawer()
-            },
-            modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
-        )
-        NavigationDrawerItem(
-            label = { Text(stringResource(id = R.string.interests_title)) },
-            icon = { Icon(painterResource(R.drawable.ic_list_alt), null) },
-            selected = currentRoute is InterestsKey,
-            onClick = {
-                navigateToInterests()
-                closeDrawer()
-            },
-            modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
-        )
+        navigationItems.forEach { navigationItem ->
+            key(navigationItem.navKey) {
+                NavigationDrawerItem(
+                    label = { Text(stringResource(id = navigationItem.labelResourceId)) },
+                    icon = { Icon(painterResource(navigationItem.iconResourceId), null) },
+                    selected = currentTopLevelRoute == navigationItem.navKey,
+                    onClick = {
+                        navigate(navigationItem.navKey)
+                        closeDrawer()
+                    },
+                    modifier = Modifier.padding(NavigationDrawerItemDefaults.ItemPadding),
+                )
+            }
+        }
     }
 }
 
@@ -105,9 +101,9 @@ fun PreviewAppDrawer() {
     JetnewsTheme {
         AppDrawer(
             drawerState = rememberDrawerState(initialValue = DrawerValue.Open),
-            currentRoute = HomeKey,
-            navigateToHome = {},
-            navigateToInterests = {},
+            currentTopLevelRoute = HomeKey,
+            navigate = {},
+            navigationItems = TOP_LEVEL_ROUTES,
             closeDrawer = { },
         )
     }

JetNews/app/src/main/java/com/example/jetnews/ui/JetnewsApp.kt

@@ -32,6 +32,8 @@ import com.example.jetnews.ui.components.AppNavRail
 import com.example.jetnews.ui.home.HomeKey
 import com.example.jetnews.ui.interests.InterestsKey
 import com.example.jetnews.ui.navigation.Navigator
+import com.example.jetnews.ui.navigation.PopUpTo
+import com.example.jetnews.ui.navigation.TOP_LEVEL_ROUTES
 import com.example.jetnews.ui.navigation.rememberNavigationState
 import com.example.jetnews.ui.theme.JetnewsTheme
 import kotlinx.coroutines.launch
@@ -61,9 +63,9 @@ fun JetnewsApp(appContainer: AppContainer, isBackEnabled: Boolean, initialBackSt
             drawerContent = {
                 AppDrawer(
                     drawerState = sizeAwareDrawerState,
-                    currentRoute = navigationState.topLevelRoute,
-                    navigateToHome = navigator::toHome,
-                    navigateToInterests = navigator::toInterests,
+                    currentTopLevelRoute = navigationState.topLevelRoute,
+                    navigate = { navKey -> navigator.navigate(navKey, PopUpTo(navKey)) },
+                    navigationItems = TOP_LEVEL_ROUTES,
                     closeDrawer = { coroutineScope.launch { sizeAwareDrawerState.close() } },
                 )
             },
@@ -74,16 +76,16 @@ fun JetnewsApp(appContainer: AppContainer, isBackEnabled: Boolean, initialBackSt
             Row {
                 if (isExpandedScreen) {
                     AppNavRail(
-                        currentRoute = navigationState.topLevelRoute,
-                        navigateToHome = navigator::toHome,
-                        navigateToInterests = navigator::toInterests,
+                        currentTopLevelRoute = navigationState.topLevelRoute,
+                        navigationItems = TOP_LEVEL_ROUTES,
+                        navigate = { navKey -> navigator.navigate(navKey) },
                     )
                 }
                 JetnewsNavDisplay(
                     navigationState = navigationState,
                     navigator = navigator,
                     appContainer = appContainer,
-                    onBack = navigator::goBack,
+                    onBack = navigator::goUp,
                     isExpandedScreen = isExpandedScreen,
                     isBackEnabled = isBackEnabled,
                     openDrawer = { coroutineScope.launch { sizeAwareDrawerState.open() } },

JetNews/app/src/main/java/com/example/jetnews/ui/JetnewsNavDisplay.kt

@@ -35,11 +35,14 @@ import androidx.navigationevent.NavigationEvent
 import androidx.navigationevent.compose.NavigationBackHandler
 import androidx.navigationevent.compose.rememberNavigationEventState
 import com.example.jetnews.data.AppContainer
+import com.example.jetnews.ui.home.HomeKey
 import com.example.jetnews.ui.home.homeEntry
 import com.example.jetnews.ui.interests.interestsEntry
 import com.example.jetnews.ui.navigation.NavigationState
 import com.example.jetnews.ui.navigation.Navigator
+import com.example.jetnews.ui.navigation.PopUpTo
 import com.example.jetnews.ui.navigation.rememberListDetailSceneStrategy
+import com.example.jetnews.ui.post.PostKey
 import com.example.jetnews.ui.post.postEntry
 
 const val PIVOT_FRACTION_OFFSET = .2f
@@ -65,12 +68,12 @@ fun JetnewsNavDisplay(
             postsRepository = appContainer.postsRepository,
             isExpandedScreen = { currentIsExpandedScreen },
             openDrawer = openDrawer,
-            navigateToPost = { navigator.toPost(it) },
+            navigateToPost = { navigator.navigate(PostKey(it), popUpTo = PopUpTo(HomeKey)) },
         )
         postEntry(
             postsRepository = appContainer.postsRepository,
             isExpandedScreen = { currentIsExpandedScreen },
-            onBack = navigator::goBack,
+            onBack = navigator::goUp,
         )
         interestsEntry(
             interestsRepository = appContainer.interestsRepository,

JetNews/app/src/main/java/com/example/jetnews/ui/MainActivity.kt

@@ -44,9 +44,9 @@ class MainActivity : ComponentActivity() {
             var initialBackStack by rememberInitialBackStack(initialDeepLinkBackStack ?: listOf(HomeKey))
 
             NewIntentEffect { newIntent ->
-                newIntent.data?.handleDeepLink()?.let {
+                newIntent.data?.handleDeepLink()?.let { deepLinkBackStack ->
                     isOpenedByDeepLink = true
-                    initialBackStack = it
+                    initialBackStack = deepLinkBackStack
                 }
             }
 

JetNews/app/src/main/java/com/example/jetnews/ui/components/AppNavRail.kt

@@ -25,6 +25,7 @@ import androidx.compose.material3.NavigationRail
 import androidx.compose.material3.NavigationRailItem
 import androidx.compose.material3.Text
 import androidx.compose.runtime.Composable
+import androidx.compose.runtime.key
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.res.painterResource
 import androidx.compose.ui.res.stringResource
@@ -33,11 +34,17 @@ import androidx.compose.ui.unit.dp
 import androidx.navigation3.runtime.NavKey
 import com.example.jetnews.R
 import com.example.jetnews.ui.home.HomeKey
-import com.example.jetnews.ui.interests.InterestsKey
+import com.example.jetnews.ui.navigation.NavigationItem
+import com.example.jetnews.ui.navigation.TOP_LEVEL_ROUTES
 import com.example.jetnews.ui.theme.JetnewsTheme
 
 @Composable
-fun AppNavRail(currentRoute: NavKey, navigateToHome: () -> Unit, navigateToInterests: () -> Unit, modifier: Modifier = Modifier) {
+fun AppNavRail(
+    currentTopLevelRoute: NavKey,
+    navigate: (NavKey) -> Unit,
+    navigationItems: List<NavigationItem>,
+    modifier: Modifier = Modifier,
+) {
     NavigationRail(
         header = {
             Icon(
@@ -50,20 +57,23 @@ fun AppNavRail(currentRoute: NavKey, navigateToHome: () -> Unit, navigateToInter
         modifier = modifier,
     ) {
         Spacer(Modifier.weight(1f))
-        NavigationRailItem(
-            selected = currentRoute is HomeKey,
-            onClick = navigateToHome,
-            icon = { Icon(painterResource(id = R.drawable.ic_home), stringResource(R.string.home_title)) },
-            label = { Text(stringResource(R.string.home_title)) },
-            alwaysShowLabel = false,
-        )
-        NavigationRailItem(
-            selected = currentRoute is InterestsKey,
-            onClick = navigateToInterests,
-            icon = { Icon(painterResource(id = R.drawable.ic_list_alt), stringResource(R.string.interests_title)) },
-            label = { Text(stringResource(R.string.interests_title)) },
-            alwaysShowLabel = false,
-        )
+
+        navigationItems.forEach { topLevelRoute ->
+            key(topLevelRoute.navKey) {
+                NavigationRailItem(
+                    selected = currentTopLevelRoute == topLevelRoute.navKey,
+                    onClick = { navigate(topLevelRoute.navKey) },
+                    icon = {
+                        Icon(
+                            painterResource(id = topLevelRoute.iconResourceId),
+                            stringResource(topLevelRoute.iconContentDescriptionResourceId),
+                        )
+                    },
+                    label = { Text(stringResource(topLevelRoute.labelResourceId)) },
+                    alwaysShowLabel = false,
+                )
+            }
+        }
         Spacer(Modifier.weight(1f))
     }
 }
@@ -74,9 +84,9 @@ fun AppNavRail(currentRoute: NavKey, navigateToHome: () -> Unit, navigateToInter
 fun PreviewAppNavRail() {
     JetnewsTheme {
         AppNavRail(
-            currentRoute = HomeKey,
-            navigateToHome = {},
-            navigateToInterests = {},
+            currentTopLevelRoute = HomeKey,
+            navigationItems = TOP_LEVEL_ROUTES,
+            navigate = {},
         )
     }
 }