Eases building navigation flows with AndroidX Navigation 3 and Koin; registers destinations and deep links in DI, provides entry providers, and auto-generates serializers for rememberNavBackStack.
Navigation3 Companion is a Kotlin Multiplatform library that makes it easier to build navigation flows with AndroidX Navigation 3 and Koin.
rememberNavBackStackAdd the dependency to your project:
dependencies {
implementation("com.mayakapps:nav3-companion:0.1.0")
}
Then, in your Koin module, register your navigation destinations and deep links:
val appModule = module {
// `Navigator` is app-specific and should be implemented by the app.
// `nav3cDeepLinkHandler` is a factory function that provides a `DeepLinkHandler` with all registered deep links.
// Check out the sample app for an example of a simple `Navigator` implementation.
single { Navigator(deepLinkHandler = nav3cDeepLinkHandler()) }
}
featureModule = module {
nav3cDeepLink<ProfileRoute>() { _ ->
}
nav3cDeepLink<ProfileRoute>() { route ->
<Navigator>().setBackStack(
listOf(
HomeRoute,
SearchRoute(query = route.userId),
ProfileRoute(userId = route.userId),
),
)
}
nav3cEntry<ProfileRoute> { route ->
navigator = <Navigator>()
ProfileScreen(
userId = route.userId,
onBack = { navigator.pop() },
)
}
}
Delegate deep link handling to your Navigator, which can delegate to the DeepLinkHandler
provided by nav3cDeepLinkHandler():
deepLinkHandler.handle(uriString)
Finally, set up your NavDisplay and NavBackStack:
@Composable
fun App() {
val navigator = koinInject<Navigator>()
val backStack = rememberNavBackStack(
configuration = nav3cSavedStateConfiguration(),
HomeRoute,
)
// `remember` is used instead of `LaunchedEffect` to apply queued deep links before the first composition,
remember(navigator, backStack) {
navigator.initializeBackStack(backStack)
}
NavDisplay(
backStack = backStack,
onBack = { navigator.pop() },
entryProvider = nav3cEntryProvider(),
entryDecorators = listOf(
rememberSaveableStateHolderNavEntryDecorator(),
rememberViewModelStoreNavEntryDecorator(),
),
)
}
Navigation3 Companion is licensed under Apache License 2.0. See LICENSE for details.
Contributions are welcome! Please open an issue or submit a pull request with any improvements or bug fixes. Make sure to follow the existing code style and include tests for any new functionality.
Surfaced from shared tags and platforms — no rankings paid for.