[#617] Migrate template compose to navigation 3

Author: eeeeaa

template-compose/app/build.gradle.kts

@@ -5,6 +5,7 @@ plugins {
     alias(libs.plugins.compose.compiler)
     alias(libs.plugins.kotlin.android)
     alias(libs.plugins.kotlin.parcelize)
+    alias(libs.plugins.kotlin.serialization)
     alias(libs.plugins.ksp)
     alias(libs.plugins.hilt)
     alias(libs.plugins.kover)
@@ -138,6 +139,7 @@ dependencies {
     ksp(libs.hilt.compiler)
 
     implementation(libs.kotlinx.collections.immutable)
+    implementation(libs.kotlinx.serialization.json)
 
     implementation(libs.timber)
     debugImplementation(libs.chucker)

template-compose/app/src/main/java/co/nimblehq/template/compose/di/modules/main/MainActivityModule.kt

@@ -1,9 +1,34 @@
 package co.nimblehq.template.compose.di.modules.main
 
+import androidx.hilt.lifecycle.viewmodel.compose.hiltViewModel
+import co.nimblehq.template.compose.navigation.EntryProviderInstaller
+import co.nimblehq.template.compose.navigation.Navigator
+import co.nimblehq.template.compose.navigation.NavigatorImpl
+import co.nimblehq.template.compose.ui.screens.main.home.Home
+import co.nimblehq.template.compose.ui.screens.main.home.HomeScreen
 import dagger.Module
+import dagger.Provides
 import dagger.hilt.InstallIn
-import dagger.hilt.android.components.ActivityComponent
+import dagger.hilt.android.components.ActivityRetainedComponent
+import dagger.hilt.android.scopes.ActivityRetainedScoped
+import dagger.multibindings.IntoSet
 
 @Module
-@InstallIn(ActivityComponent::class)
-class MainActivityModule
+@InstallIn(ActivityRetainedComponent::class)
+object MainActivityModule {
+
+    @Provides
+    @ActivityRetainedScoped
+    fun provideNavigator(): Navigator = NavigatorImpl(startDestination = Home)
+
+    @IntoSet
+    @Provides
+    fun provideEntryProviderInstaller(navigator: Navigator): EntryProviderInstaller = {
+        entry<Home> {
+            HomeScreen(
+                viewModel = hiltViewModel(),
+                navigator = navigator
+            )
+        }
+    }
+}

template-compose/app/src/main/java/co/nimblehq/template/compose/extensions/ComponentActivityExt.kt

@@ -0,0 +1,14 @@
+package co.nimblehq.template.compose.extensions
+
+import android.os.Build
+import androidx.activity.ComponentActivity
+import androidx.activity.enableEdgeToEdge
+
+fun ComponentActivity.setEdgeToEdgeConfig() {
+    enableEdgeToEdge()
+    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
+        // Force the 3-button navigation bar to be transparent
+        // See: https://developer.android.com/develop/ui/views/layout/edge-to-edge#create-transparent
+        window.isNavigationBarContrastEnforced = false
+    }
+}

template-compose/app/src/main/java/co/nimblehq/template/compose/extensions/SavedStateHandleExt.kt

@@ -0,0 +1,18 @@
+package co.nimblehq.template.compose.navigation
+
+import androidx.compose.runtime.snapshots.SnapshotStateList
+import androidx.navigation3.runtime.EntryProviderScope
+import kotlin.reflect.KClass
+
+typealias EntryProviderInstaller = EntryProviderScope<Any>.() -> Unit
+
+interface Navigator {
+
+    val backStack: SnapshotStateList<Any>
+
+    fun goTo(destination: Any)
+
+    fun goBack()
+
+    fun goBackToLast(destinationClass: KClass<*>)
+}

template-compose/app/src/main/java/co/nimblehq/template/compose/navigation/Navigator.kt

@@ -0,0 +1,29 @@
+package co.nimblehq.template.compose.navigation
+
+import androidx.compose.runtime.mutableStateListOf
+import androidx.compose.runtime.snapshots.SnapshotStateList
+import dagger.hilt.android.scopes.ActivityRetainedScoped
+import kotlin.reflect.KClass
+
+@ActivityRetainedScoped
+class NavigatorImpl(startDestination: Any) : Navigator {
+    override val backStack: SnapshotStateList<Any> = mutableStateListOf(startDestination)
+
+    override fun goTo(destination: Any) {
+        backStack.add(destination)
+    }
+
+    override fun goBack() {
+        backStack.removeLastOrNull()
+    }
+
+    override fun goBackToLast(destinationClass: KClass<*>) {
+        val index = backStack.indexOfLast {
+            destinationClass.isInstance(it)
+        }
+
+        if (index in backStack.indices) {
+            backStack.removeRange(index + 1, backStack.size)
+        }
+    }
+}

template-compose/app/src/main/java/co/nimblehq/template/compose/navigation/NavigatorImpl.kt

@@ -18,7 +18,7 @@ abstract class BaseViewModel : ViewModel() {
     protected val _error = MutableSharedFlow<Throwable>()
     val error = _error.asSharedFlow()
 
-    protected val _navigator = MutableSharedFlow<BaseDestination>()
+    protected val _navigator = MutableSharedFlow<Any>()
     val navigator = _navigator.asSharedFlow()
 
     /**