Work with koin-compose-navigation3 directly

Author: arnaudgiuliani

app/build.gradle.kts

@@ -85,6 +85,7 @@ dependencies {
     implementation(libs.hilt.android)
     ksp(libs.hilt.compiler)
     implementation(libs.koin.compose.viewmodel)
+    implementation(libs.koin.navigation3)
 
     testImplementation(libs.junit)
     androidTestImplementation(libs.androidx.junit)

app/src/main/java/com/example/nav3recipes/modular/koin/AppModule.kt

@@ -1,60 +1,14 @@
 package com.example.nav3recipes.modular.koin
 
-import androidx.compose.runtime.Composable
-import androidx.navigation3.runtime.entry
-import com.example.nav3recipes.modular.hilt.EntryProviderInstaller
-import org.koin.core.annotation.KoinInternalApi
-import org.koin.core.definition.KoinDefinition
-import org.koin.core.module.KoinDslMarker
-import org.koin.core.module.Module
-import org.koin.core.module._scopedInstanceFactory
-import org.koin.core.module._singleInstanceFactory
-import org.koin.core.qualifier.named
-import org.koin.core.scope.Scope
-import org.koin.dsl.ScopeDSL
+import org.koin.androidx.scope.dsl.activityRetainedScope
 import org.koin.dsl.module
 
 val appModule = module {
     includes(profileModule,conversationModule)
 
-    scope<KoinModularActivity> {
+    activityRetainedScope {
         scoped {
             Navigator(startDestination = ConversationList)
         }
     }
-}
-
-@KoinDslMarker
-fun Scope.navigator(): Navigator = get<Navigator>()
-
-//TODO Need typealias EntryProviderInstaller = EntryProviderBuilder<Any>.() -> Unit-
-
-@KoinDslMarker
-@OptIn(KoinInternalApi::class)
-inline fun <reified T : Any> ScopeDSL.navigation(
-    noinline definition: @Composable Scope.(T) -> Unit,
-): KoinDefinition<EntryProviderInstaller> {
-    val def = _scopedInstanceFactory<EntryProviderInstaller>(named<T>(), {
-        val scope = this
-        {
-            entry<T>(content = {definition(scope,it)})
-        }
-    }, scopeQualifier)
-    module.indexPrimaryType(def)
-    return KoinDefinition(module, def)
-}
-
-@KoinDslMarker
-@OptIn(KoinInternalApi::class)
-inline fun <reified T : Any> Module.navigation(
-    noinline definition: @Composable Scope.(T) -> Unit,
-): KoinDefinition<EntryProviderInstaller> {
-    val def = _singleInstanceFactory<EntryProviderInstaller>(named<T>(), {
-        val scope = this
-        {
-            entry<T>(content = {definition(scope,it)})
-        }
-    })
-    indexPrimaryType(def)
-    return KoinDefinition(this, def)
 }

app/src/main/java/com/example/nav3recipes/modular/koin/CommonModule.kt

@@ -2,12 +2,6 @@ package com.example.nav3recipes.modular.koin
 
 import androidx.compose.runtime.mutableStateListOf
 import androidx.compose.runtime.snapshots.SnapshotStateList
-import androidx.navigation3.runtime.EntryProviderBuilder
-import dagger.hilt.android.scopes.ActivityRetainedScoped
-import javax.inject.Inject
-
-
-typealias EntryProviderInstaller = EntryProviderBuilder<Any>.() -> Unit
 
 class Navigator(startDestination: Any) {
     val backStack : SnapshotStateList<Any> = mutableStateListOf(startDestination)

app/src/main/java/com/example/nav3recipes/modular/koin/ConversationModule.kt

@@ -21,7 +21,10 @@ import androidx.compose.ui.Modifier
 import androidx.compose.ui.graphics.Color
 import androidx.compose.ui.unit.dp
 import com.example.nav3recipes.ui.theme.colors
+import org.koin.androidx.scope.dsl.activityRetainedScope
+import org.koin.core.annotation.KoinExperimentalAPI
 import org.koin.dsl.module
+import org.koin.dsl.navigation3.navigation
 
 // API
 object ConversationList
@@ -30,19 +33,20 @@ data class ConversationDetail(val id: Int) {
         get() = colors[id % colors.size]
 }
 
+@OptIn(KoinExperimentalAPI::class)
 val conversationModule = module {
-    scope<KoinModularActivity> {
+    activityRetainedScope {
         navigation<ConversationList> {
             ConversationListScreen(
                 onConversationClicked = { conversationDetail ->
-                    navigator().goTo(conversationDetail)
+                    get<Navigator>().goTo(conversationDetail)
                 }
             )
         }
 
         navigation<ConversationDetail> { key ->
             ConversationDetailScreen(key) {
-                navigator().goTo(com.example.nav3recipes.modular.koin.Profile)
+                get<Navigator>().goTo(Profile)
             }
         }
     }

app/src/main/java/com/example/nav3recipes/modular/koin/KoinModularActivity.kt

@@ -1,30 +1,21 @@
 package com.example.nav3recipes.modular.koin
 
-import android.content.ComponentCallbacks
 import android.os.Bundle
 import androidx.activity.ComponentActivity
 import androidx.activity.compose.setContent
 import androidx.compose.foundation.layout.padding
 import androidx.compose.material3.Scaffold
 import androidx.compose.ui.Modifier
-import androidx.navigation3.runtime.NavEntry
-import androidx.navigation3.runtime.entryProvider
 import androidx.navigation3.ui.NavDisplay
-import com.example.nav3recipes.modular.hilt.EntryProviderInstaller
 import com.example.nav3recipes.ui.setEdgeToEdgeConfig
-import org.koin.android.ext.android.get
-import org.koin.android.ext.android.getKoin
-import org.koin.android.ext.android.getKoinScope
 import org.koin.android.ext.android.inject
 import org.koin.android.ext.koin.androidContext
 import org.koin.android.scope.AndroidScopeComponent
+import org.koin.androidx.compose.navigation3.getEntryProvider
 import org.koin.androidx.scope.activityRetainedScope
-import org.koin.compose.getKoin
-import org.koin.core.annotation.KoinInternalApi
+import org.koin.core.annotation.KoinExperimentalAPI
 import org.koin.core.context.startKoin
 import org.koin.core.context.stopKoin
-import org.koin.core.parameter.ParametersDefinition
-import org.koin.core.qualifier.Qualifier
 import org.koin.core.scope.Scope
 import org.koin.mp.KoinPlatform
 
@@ -42,28 +33,7 @@ import org.koin.mp.KoinPlatform
  * The app module creates the navigator by supplying a start destination and provides this navigator
  * to the rest of the app module (i.e. MainActivity) and the feature modules.
  */
-
-typealias EntryProvider = (Any) -> NavEntry<Any>
-
-@OptIn(KoinInternalApi::class)
-inline fun ComponentCallbacks.entryProvider(
-    mode: LazyThreadSafetyMode = LazyThreadSafetyMode.SYNCHRONIZED,
-) : Lazy<EntryProvider> = lazy(mode) { val entries = getKoinScope().getAll<EntryProviderInstaller>()
-    val entryProvider: (Any) -> NavEntry<Any> = entryProvider {
-        entries.forEach { builder -> this.builder() }
-    }
-    entryProvider
-}
-
-@OptIn(KoinInternalApi::class)
-inline fun ComponentCallbacks.getEntryProvider() : EntryProvider {
-    val entries = getKoinScope().getAll<EntryProviderInstaller>()
-    val entryProvider: (Any) -> NavEntry<Any> = entryProvider {
-        entries.forEach { builder -> this.builder() }
-    }
-    return entryProvider
-}
-
+@OptIn(KoinExperimentalAPI::class)
 class KoinModularActivity : ComponentActivity(), AndroidScopeComponent {
 
     override val scope : Scope by activityRetainedScope()

app/src/main/java/com/example/nav3recipes/modular/koin/ProfileModule.kt

@@ -11,16 +11,18 @@ import androidx.compose.runtime.Composable
 import androidx.compose.ui.Alignment
 import androidx.compose.ui.Modifier
 import androidx.compose.ui.unit.dp
+import org.koin.androidx.scope.dsl.activityRetainedScope
+import org.koin.core.annotation.KoinExperimentalAPI
 import org.koin.dsl.module
+import org.koin.dsl.navigation3.navigation
 
 // API
 object Profile
 
+@OptIn(KoinExperimentalAPI::class)
 val profileModule = module {
-    scope<KoinModularActivity> {
-        navigation<Profile> {
-            ProfileScreen()
-        }
+    activityRetainedScope {
+        navigation<Profile> { ProfileScreen() }
     }
 }
 

gradle/libs.versions.toml

@@ -26,13 +26,13 @@ lifecycleViewmodel = "1.0.0-alpha04"
 activityCompose = "1.12.0-alpha09"
 composeBom = "2025.09.01"
 navigation2 = "2.9.1"
-navigation3 = "1.0.0-alpha11"
+navigation3 = "1.0.0-beta01"
 material3 = "1.4.0"
 nav3Material = "1.3.0-alpha01"
 ksp = "2.2.10-2.0.2"
 hilt = "2.57.1"
 hiltNavigationCompose = "1.3.0"
-koin = "4.1.1"
+koin = "4.2.0-alpha1"
 
 [libraries]
 androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" }
@@ -63,6 +63,7 @@ kotlinx-serialization-json = { module = "org.jetbrains.kotlinx:kotlinx-serializa
 androidx-material-icons-extended = { group = "androidx.compose.material", name = "material-icons-extended" }
 androidx-material3-navigation3 = { group = "androidx.compose.material3.adaptive", name = "adaptive-navigation3", version.ref = "nav3Material" }
 koin-compose-viewmodel = {group = "io.insert-koin", name = "koin-compose-viewmodel", version.ref = "koin"}
+koin-navigation3 = {group = "io.insert-koin", name = "koin-compose-navigation3", version.ref = "koin"}
 
 [plugins]
 android-application = { id = "com.android.application", version.ref = "agp" }