Route based navigation support

InsertKoinIO · Mar 12, 2024 · ab7731f · ab7731f
1 parent 0dcf904
commit ab7731f
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 2 deletions.
diff --git a/docs/reference/koin-android/viewmodel.md b/docs/reference/koin-android/viewmodel.md
@@ -165,12 +165,13 @@ All `stateViewModel` functions are deprecated. You can just use the regular `vie
 
 ## Navigation Graph ViewModel
 
-You can scope a ViewModel instance to your Navigation graph. Just retrieve with `by koinNavGraphViewModel()`. You just need your graph id.
+You can scope a ViewModel instance to your Navigation graph. Just retrieve with `by koinNavGraphViewModel()`. You need either your graph id or graph route.
 
 ```kotlin
 class NavFragment : Fragment() {
 
-    val mainViewModel: NavViewModel by koinNavGraphViewModel(R.id.my_graph)
+    val mainViewModel: NavViewModel by koinNavGraphViewModel(R.id.my_graph) // id based
+    val secondaryViewModel: NavViewModel by koinNavGraphViewModel("my_graph_route") // route based
 
 }
 ```

diff --git a/...ndroid/koin-androidx-navigation/src/main/java/org/koin/androidx/navigation/NavGraphExt.kt b/...ndroid/koin-androidx-navigation/src/main/java/org/koin/androidx/navigation/NavGraphExt.kt
@@ -41,3 +41,20 @@ inline fun <reified VM : ViewModel> Fragment.koinNavGraphViewModel(
 ): Lazy<VM> {
     return viewModel(qualifier, ownerProducer, extrasProducer, parameters)
 }
+
+/**
+ * Request a ViewModel instance, scoped to Navigation graph
+ *
+ * @param route
+ *
+ * @author Sebastian Helzer
+ */
+inline fun <reified VM : ViewModel> Fragment.koinNavGraphViewModel(
+    route: Int,
+    qualifier: Qualifier? = null,
+    noinline ownerProducer: () -> ViewModelStoreOwner = { findNavController().getBackStackEntry(route) },
+    noinline extrasProducer: (() -> CreationExtras)? = null,
+    noinline parameters: (() -> ParametersHolder)? = null,
+): Lazy<VM> {
+    return viewModel(qualifier, ownerProducer, extrasProducer, parameters)
+}