[#610] [Part 2] Update navigation library and refactor template to expose event callback to navigate #612
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,65 @@ | ||
| package co.nimblehq.template.compose.extensions | ||
|
|
||
| import androidx.navigation.NavHostController | ||
| import androidx.navigation.NavOptionsBuilder | ||
| import co.nimblehq.template.compose.ui.base.BaseAppDestination | ||
| import kotlin.collections.component1 | ||
| import kotlin.collections.component2 | ||
|
|
||
| /** | ||
| * Use this extension or [navigate(BaseAppDestination.Up())] to prevent duplicated navigation events | ||
| */ | ||
| fun NavHostController.navigateAppDestinationUp() { | ||
| navigateTo(BaseAppDestination.Up()) | ||
| } | ||
|
|
||
| private const val IntervalInMillis: Long = 1000L | ||
| private var lastNavigationEventExecutedTimeInMillis: Long = 0L | ||
|
|
||
| /** | ||
| * Use this extension to prevent duplicated navigation events with the same destination in a short time | ||
| */ | ||
| private fun NavHostController.throttleNavigation( | ||
| appDestination: BaseAppDestination, | ||
| onNavigate: () -> Unit, | ||
| ) { | ||
| val currentTime = System.currentTimeMillis() | ||
| if (currentBackStackEntry?.destination?.route == appDestination.route | ||
| && (currentTime - lastNavigationEventExecutedTimeInMillis < IntervalInMillis) | ||
| ) { | ||
| return | ||
| } | ||
| lastNavigationEventExecutedTimeInMillis = currentTime | ||
|
|
||
| onNavigate() | ||
| } | ||
|
|
||
| /** | ||
| * Navigate to provided [BaseAppDestination] | ||
| * Caution to use this method. This method use savedStateHandle to store the Parcelable data. | ||
| * When previousBackstackEntry is popped out from navigation stack, savedStateHandle will return null and cannot retrieve data. | ||
| * eg.Login -> Home, the Login screen will be popped from the back-stack on logging in successfully. | ||
| */ | ||
| fun <T : BaseAppDestination> NavHostController.navigateTo( | ||
| appDestination: T, | ||
| builder: (NavOptionsBuilder.() -> Unit)? = null, | ||
| ) = throttleNavigation(appDestination) { | ||
| when (appDestination) { | ||
| is BaseAppDestination.Up -> { | ||
| appDestination.results.forEach { (key, value) -> | ||
| previousBackStackEntry?.savedStateHandle?.set(key, value) | ||
| } | ||
| navigateUp() | ||
| } | ||
| else -> { | ||
| appDestination.parcelableArgument?.let { (key, value) -> | ||
| currentBackStackEntry?.savedStateHandle?.set(key, value) | ||
| } | ||
| navigate(route = appDestination.destination) { | ||
| if (builder != null) { | ||
| builder() | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,81 @@ | ||
| package co.nimblehq.template.compose.extensions | ||
|
|
||
| import androidx.compose.animation.AnimatedContentScope | ||
| import androidx.compose.animation.AnimatedContentTransitionScope | ||
| import androidx.compose.animation.EnterTransition | ||
| import androidx.compose.animation.ExitTransition | ||
| import androidx.compose.animation.core.tween | ||
| import androidx.compose.runtime.Composable | ||
| import androidx.navigation.NavBackStackEntry | ||
| import androidx.navigation.NavDeepLink | ||
| import androidx.navigation.NavGraphBuilder | ||
| import androidx.navigation.compose.composable | ||
| import co.nimblehq.template.compose.ui.base.BaseAppDestination | ||
|
|
||
| private const val NavAnimationDurationInMillis = 300 | ||
|
|
||
| fun AnimatedContentTransitionScope<NavBackStackEntry>.enterSlideInLeftTransition() = | ||
| slideIntoContainer( | ||
| towards = AnimatedContentTransitionScope.SlideDirection.Start, | ||
| animationSpec = tween(NavAnimationDurationInMillis) | ||
| ) | ||
|
|
||
| fun AnimatedContentTransitionScope<NavBackStackEntry>.exitSlideOutLeftTransition() = | ||
| slideOutOfContainer( | ||
| towards = AnimatedContentTransitionScope.SlideDirection.Start, | ||
| animationSpec = tween(NavAnimationDurationInMillis) | ||
| ) | ||
|
|
||
| fun AnimatedContentTransitionScope<NavBackStackEntry>.enterSlideInRightTransition() = | ||
| slideIntoContainer( | ||
| towards = AnimatedContentTransitionScope.SlideDirection.End, | ||
| animationSpec = tween(NavAnimationDurationInMillis) | ||
| ) | ||
|
|
||
| fun AnimatedContentTransitionScope<NavBackStackEntry>.exitSlideOutRightTransition() = | ||
| slideOutOfContainer( | ||
| towards = AnimatedContentTransitionScope.SlideDirection.End, | ||
| animationSpec = tween(NavAnimationDurationInMillis) | ||
| ) | ||
|
|
||
| fun AnimatedContentTransitionScope<NavBackStackEntry>.enterSlideInUpTransition() = | ||
| slideIntoContainer( | ||
| towards = AnimatedContentTransitionScope.SlideDirection.Up, | ||
| animationSpec = tween(NavAnimationDurationInMillis) | ||
| ) | ||
|
|
||
| fun AnimatedContentTransitionScope<NavBackStackEntry>.exitSlideOutDownTransition() = | ||
| slideOutOfContainer( | ||
| towards = AnimatedContentTransitionScope.SlideDirection.Down, | ||
| animationSpec = tween(NavAnimationDurationInMillis) | ||
| ) | ||
|
|
||
| fun NavGraphBuilder.composable( | ||
| destination: BaseAppDestination, | ||
| deepLinks: List<NavDeepLink> = emptyList(), | ||
| enterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = { | ||
| enterSlideInLeftTransition() | ||
| }, | ||
| exitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = { | ||
| exitSlideOutLeftTransition() | ||
| }, | ||
| popEnterTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> EnterTransition?)? = { | ||
| enterSlideInRightTransition() | ||
| }, | ||
| popExitTransition: (AnimatedContentTransitionScope<NavBackStackEntry>.() -> ExitTransition?)? = { | ||
| exitSlideOutRightTransition() | ||
| }, | ||
| content: @Composable AnimatedContentScope.(NavBackStackEntry) -> Unit, | ||
| ) { | ||
| composable( | ||
| route = destination.route, | ||
| arguments = destination.arguments, | ||
| deepLinks = deepLinks, | ||
| enterTransition = enterTransition, | ||
| exitTransition = exitTransition, | ||
| popEnterTransition = popEnterTransition, | ||
| popExitTransition = popExitTransition, | ||
| content = content | ||
| ) | ||
| } | ||
|
|
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 |
|---|---|---|
| @@ -1,10 +1,10 @@ | ||
| package co.nimblehq.template.compose.ui | ||
|
|
||
| import co.nimblehq.template.compose.ui.base.BaseAppDestination | ||
|
|
||
| sealed class AppDestination { | ||
|
|
||
| object RootNavGraph : BaseAppDestination("rootNavGraph") | ||
|
|
||
| object MainNavGraph : BaseAppDestination("mainNavGraph") | ||
| } |
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 |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| package co.nimblehq.template.compose.ui.base | ||
|
|
||
| import androidx.navigation.NamedNavArgument | ||
|
|
||
| const val KeyResultOk = "keyResultOk" | ||
|
|
||
| /** | ||
| * Use "class" over "object" for destinations with [parcelableArgument] usage or a [navArgument] with [defaultValue] set | ||
| * to reset destination nav arguments. | ||
| */ | ||
| abstract class BaseAppDestination(val route: String = "") { | ||
|
|
||
| open val arguments: List<NamedNavArgument> = emptyList() | ||
|
|
||
| open val deepLinks: List<String> = listOf( | ||
| "https://android.nimblehq.co/$route", | ||
| "android://$route", | ||
| ) | ||
|
|
||
| open var destination: String = route | ||
|
|
||
| open var parcelableArgument: Pair<String, Any?>? = null | ||
|
|
||
| data class Up( | ||
| val results: HashMap<String, Any> = hashMapOf(), | ||
| ) : BaseAppDestination() { | ||
|
|
||
| fun put(key: String, value: Any) = apply { | ||
| results[key] = value | ||
| } | ||
| } | ||
| } |
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 |
|---|---|---|
| @@ -1,8 +1,8 @@ | ||
| package co.nimblehq.template.compose.ui.screens.main | ||
|
|
||
| import co.nimblehq.template.compose.ui.base.BaseAppDestination | ||
|
|
||
| sealed class MainDestination { | ||
|
|
||
| object Home : BaseAppDestination("home") | ||
| } |
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
Oops, something went wrong.
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.