JetNews: Migrate from Navigation 2 to Navigation 3 #1644
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,66 +17,61 @@ | |
| package com.example.jetnews.ui | ||
|
|
||
| import androidx.compose.runtime.Composable | ||
| import androidx.compose.runtime.snapshots.SnapshotStateList | ||
| import androidx.compose.ui.Modifier | ||
| import androidx.lifecycle.viewmodel.compose.viewModel | ||
| import androidx.lifecycle.viewmodel.navigation3.rememberViewModelStoreNavEntryDecorator | ||
| import androidx.navigation3.runtime.NavEntry | ||
| import androidx.navigation3.runtime.rememberSaveableStateHolderNavEntryDecorator | ||
| import androidx.navigation3.ui.NavDisplay | ||
| import com.example.jetnews.data.AppContainer | ||
| import com.example.jetnews.ui.home.HomeRoute | ||
| import com.example.jetnews.ui.home.HomeViewModel | ||
| import com.example.jetnews.ui.interests.InterestsRoute | ||
| import com.example.jetnews.ui.interests.InterestsViewModel | ||
|
|
||
| @Composable | ||
| fun JetnewsNavGraph( | ||
| appContainer: AppContainer, | ||
| isExpandedScreen: Boolean, | ||
| backStack: SnapshotStateList<JetnewsRoute>, | ||
| modifier: Modifier = Modifier, | ||
| openDrawer: () -> Unit = {}, | ||
| ) { | ||
| NavDisplay( | ||
| backStack = backStack, | ||
| onBack = { backStack.removeLastOrNull() }, | ||
| modifier = modifier, | ||
| entryDecorators = listOf( | ||
| rememberSaveableStateHolderNavEntryDecorator(), | ||
| rememberViewModelStoreNavEntryDecorator(), | ||
| ), | ||
| entryProvider = { route -> | ||
| when (route) { | ||
| is Home -> NavEntry(route) { | ||
| val homeViewModel: HomeViewModel = viewModel( | ||
| factory = HomeViewModel.provideFactory( | ||
| postsRepository = appContainer.postsRepository, | ||
| preSelectedPostId = route.preSelectedPostId, | ||
| ), | ||
| ) | ||
| HomeRoute( | ||
| homeViewModel = homeViewModel, | ||
| isExpandedScreen = isExpandedScreen, | ||
| openDrawer = openDrawer, | ||
| ) | ||
| } | ||
| is Interests -> NavEntry(route) { | ||
| val interestsViewModel: InterestsViewModel = viewModel( | ||
| factory = InterestsViewModel.provideFactory(appContainer.interestsRepository), | ||
| ) | ||
| InterestsRoute( | ||
| interestsViewModel = interestsViewModel, | ||
| isExpandedScreen = isExpandedScreen, | ||
| openDrawer = openDrawer, | ||
| ) | ||
| } | ||
| } | ||
| }, | ||
| ) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,43 +16,17 @@ | |
|
|
||
| package com.example.jetnews.ui | ||
|
|
||
| import androidx.navigation3.runtime.NavKey | ||
| import kotlinx.serialization.Serializable | ||
|
|
||
| /** | ||
| * Route definitions used in [JetnewsApp]. | ||
| */ | ||
| @Serializable | ||
| sealed interface JetnewsRoute : NavKey | ||
|
|
||
| @Serializable | ||
| data class Home(val preSelectedPostId: String? = null) : JetnewsRoute | ||
|
|
||
| @Serializable | ||
| data object Interests : JetnewsRoute | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -32,9 +32,13 @@ class MainActivity : ComponentActivity() { | |
| super.onCreate(savedInstanceState) | ||
|
|
||
| val appContainer = (application as JetnewsApplication).container | ||
|
|
||
| val postId = intent?.data?.getQueryParameter("postId") | ||
| val startRoute = Home(preSelectedPostId = postId) | ||
|
|
||
| setContent { | ||
| val widthSizeClass = calculateWindowSizeClass(this).widthSizeClass | ||
| JetnewsApp(appContainer, widthSizeClass, startRoute) | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -31,11 +31,13 @@ import androidx.compose.ui.res.stringResource | |
| import androidx.compose.ui.tooling.preview.Preview | ||
| import androidx.compose.ui.unit.dp | ||
| import com.example.jetnews.R | ||
| import com.example.jetnews.ui.Home | ||
| import com.example.jetnews.ui.Interests | ||
| import com.example.jetnews.ui.JetnewsRoute | ||
| import com.example.jetnews.ui.theme.JetnewsTheme | ||
|
|
||
| @Composable | ||
| fun AppNavRail(currentRoute: JetnewsRoute, navigateToHome: () -> Unit, navigateToInterests: () -> Unit, modifier: Modifier = Modifier) { | ||
| NavigationRail( | ||
| header = { | ||
| Icon( | ||
|
|
@@ -49,14 +51,14 @@ fun AppNavRail(currentRoute: String, navigateToHome: () -> Unit, navigateToInter | |
| ) { | ||
| Spacer(Modifier.weight(1f)) | ||
| NavigationRailItem( | ||
| selected = currentRoute is Home, | ||
| 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 Interests, | ||
| onClick = navigateToInterests, | ||
| icon = { Icon(painterResource(id = R.drawable.ic_list_alt), stringResource(R.string.interests_title)) }, | ||
| label = { Text(stringResource(R.string.interests_title)) }, | ||
|
|
@@ -72,7 +74,7 @@ fun AppNavRail(currentRoute: String, navigateToHome: () -> Unit, navigateToInter | |
| fun PreviewAppNavRail() { | ||
| JetnewsTheme { | ||
| AppNavRail( | ||
| currentRoute = Home(), | ||
| navigateToHome = {}, | ||
| navigateToInterests = {}, | ||
| ) | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -17,6 +17,8 @@ androidx-lifecycle = "2.8.2" | |
| androidx-lifecycle-compose = "2.10.0" | ||
| androidx-lifecycle-runtime-compose = "2.10.0" | ||
| androidx-navigation = "2.9.6" | ||
| androidx-navigation3 = "1.0.0" | ||
| androidx-lifecycle-viewmodel-navigation3 = "2.10.0" | ||
| androidx-palette = "1.0.0" | ||
| androidx-test = "1.7.0" | ||
| androidx-test-espresso = "3.7.0" | ||
|
|
@@ -106,6 +108,9 @@ androidx-material-icons-core = { module = "androidx.compose.material:material-ic | |
| androidx-navigation-compose = { module = "androidx.navigation:navigation-compose", version.ref = "androidx-navigation" } | ||
| androidx-navigation-fragment = { module = "androidx.navigation:navigation-fragment-ktx", version.ref = "androidx-navigation" } | ||
| androidx-navigation-ui-ktx = { module = "androidx.navigation:navigation-ui-ktx", version.ref = "androidx-navigation" } | ||
| androidx-navigation3-runtime = { module = "androidx.navigation3:navigation3-runtime", version.ref = "androidx-navigation3" } | ||
| androidx-navigation3-ui = { module = "androidx.navigation3:navigation3-ui", version.ref = "androidx-navigation3" } | ||
| androidx-lifecycle-viewmodel-navigation3 = { module = "androidx.lifecycle:lifecycle-viewmodel-navigation3", version.ref = "androidx-lifecycle-viewmodel-navigation3" } | ||
| androidx-palette = { module = "androidx.palette:palette", version.ref = "androidx-palette" } | ||
| androidx-room-compiler = { module = "androidx.room:room-compiler", version.ref = "room" } | ||
| androidx-room-ktx = { module = "androidx.room:room-ktx", version.ref = "room" } | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When the
backStackbecomes empty (e.g., when the user presses back on the last screen),currentRoutedefaults toHome(). This causesAppDrawerandAppNavRailto show "Home" as selected, whileNavDisplayshows a blank screen because its backstack is empty. This creates a UI inconsistency.To fix this,
currentRouteshould be nullable. When it'snull, no navigation item will be selected, which correctly reflects the empty state.You'll also need to update the
currentRouteparameter inAppDrawerandAppNavRailto be nullable (JetnewsRoute?). Theischecks for selection will continue to work correctly.