Updated to use Navigation 3 and AGP 9

Author: Mike Lau

README.md

@@ -42,21 +42,22 @@ Each feature module is built with a sub-module that follows Domain, Data and UI
 > Details page use:
 > pokedex://pokemon/{id} where id is the pokemon number
 
+* **Uses AGP 9!**
 * **Coil Image Loading:** Attempt to load an image using Coil with or without loading animation
 * **CI/CD Using Github:** Utilizing Github Actions and Github Releases page for pipelines and deployment (uses debug apk but you can build release or sign as you like)
 * **R8:** Release and R8 ready, just make sure to generate your own keystore / signing capability
 * **Lib Versions Catalog:** Uses new lib.versions.toml versions catalog to manage dependencies and their versions
 
 ## Built With
 
-This project is built using next generation tools supported by the latest Canary version of **Android Studio Narwhal | 2025.1.1 Canary 7:**. Kotlin 2.1.20 with Compose Compiler Gradle Ready!
+This project is built using next generation tools supported by the latest Canary version of **Android Studio Panda 4 | 2025.3.4 Canary 1:**. Kotlin 2.3.20 with Compose Compiler Gradle Ready!
 
-* **Android Studio Narwhal:** IDE used
+* **Android Studio Panda:** IDE used
 * **Kotlin:** Programming Language
 * **K2 Compiler:** Enabled
 * **KSP:** Uses KSP for hilt
 * **Jetpack Compose:** UI Toolkit
-* **Jetpack Libraries:** Lifecycle, View Model, Material 3, Navigation Compose etc.
+* **Jetpack Libraries:** Lifecycle, View Model, Material 3, Navigation 3 Compose etc.
 * **Hilt:** Dependency Injection
 * **Coil:** Image Loading
 * **Retrofit & OkHttp:** Networking and API management

app/build.gradle.kts

@@ -1,6 +1,5 @@
 plugins {
     alias(libs.plugins.androidApplication)
-    alias(libs.plugins.kotlinAndroid)
     alias(libs.plugins.hilt)
     alias(libs.plugins.kotlinSerialization)
     alias(libs.plugins.kotlinKsp)
@@ -52,9 +51,6 @@ android {
         sourceCompatibility = JavaVersion.VERSION_17
         targetCompatibility = JavaVersion.VERSION_17
     }
-    kotlinOptions {
-        jvmTarget = "17"
-    }
     kotlin {
         jvmToolchain(17)
     }
@@ -97,8 +93,11 @@ dependencies {
     implementation(libs.ui.tooling.preview)
     implementation(libs.material3)
     implementation(libs.material.icons.extended)
-    implementation(libs.navigation.compose)
+    implementation(libs.nav3.runtime)
+    implementation(libs.nav3.ui)
+    implementation(libs.lifecycle.nav3)
     implementation(libs.splashscreen)
+    implementation(libs.hilt.navigation.compose)
     implementation(libs.hilt)
     ksp(libs.hilt.compiler)
     testImplementation(libs.junit)

app/src/main/java/com/mikelau/pokedex/MainActivity.kt

@@ -13,41 +13,34 @@ import androidx.compose.material3.Surface
 import androidx.compose.runtime.Composable
 import androidx.compose.ui.Modifier
 import androidx.core.splashscreen.SplashScreen.Companion.installSplashScreen
-import androidx.navigation.NavHostController
-import androidx.navigation.compose.rememberNavController
 import com.mikelau.core.common.utils.ColorBackground
 import com.mikelau.pokedex.navigation.AppNavGraph
-import com.mikelau.pokedex.navigation.NavigationProvider
+import com.mikelau.pokedex.navigation.rememberAppNavBackStack
 import dagger.hilt.android.AndroidEntryPoint
-import javax.inject.Inject
 
 @AndroidEntryPoint
 class MainActivity : ComponentActivity() {
 
-    @Inject
-    lateinit var navigationProvider: NavigationProvider
-
     override fun onCreate(savedInstanceState: Bundle?) {
         installSplashScreen()
         super.onCreate(savedInstanceState)
-
         enableEdgeToEdge()
         setContent {
-            val navController = rememberNavController()
-            App(navHostController = navController, navigationProvider)
+            App()
         }
     }
 }
 
 @Composable
-fun App(navHostController: NavHostController, navigationProvider: NavigationProvider) {
+fun App() {
     Surface(
         modifier = Modifier
             .background(ColorBackground)
             .fillMaxSize()
             .windowInsetsPadding(WindowInsets.systemBars),
         color = ColorBackground
     ) {
-        AppNavGraph(navController = navHostController, navigationProvider = navigationProvider)
+        val backStack = rememberAppNavBackStack()
+        AppNavGraph(backStack = backStack)
     }
 }

app/src/main/java/com/mikelau/pokedex/di/AppModule.kt

@@ -1,8 +1,11 @@
+@file:Suppress("unused")
+
 package com.mikelau.pokedex.di
 
 import com.mikelau.feature.pokemon.ui.navigation.PokemonApi
+import com.mikelau.feature.pokemon.ui.navigation.PokemonApiImpl
 import com.mikelau.feature.pokemondetails.ui.navigation.PokemonDetailsApi
-import com.mikelau.pokedex.navigation.NavigationProvider
+import com.mikelau.feature.pokemondetails.ui.navigation.PokemonDetailsApiImpl
 import dagger.Module
 import dagger.Provides
 import dagger.hilt.InstallIn
@@ -13,9 +16,9 @@ import dagger.hilt.components.SingletonComponent
 object AppModule {
 
     @Provides
-    fun provideNavigationProvider(pokemonApi: PokemonApi, pokemonDetailsApi: PokemonDetailsApi): NavigationProvider {
-        return NavigationProvider(pokemonApi, pokemonDetailsApi)
-    }
+    fun providePokemonApi(): PokemonApi = PokemonApiImpl()
 
+    @Provides
+    fun providePokemonDetailsApi(): PokemonDetailsApi = PokemonDetailsApiImpl()
 }
 

app/src/main/java/com/mikelau/pokedex/navigation/AppNavigation.kt

@@ -1,23 +1,48 @@
+@file:Suppress("DEPRECATION", "OPT_IN_USAGE")
+
 package com.mikelau.pokedex.navigation
 
 import androidx.compose.runtime.Composable
-import androidx.navigation.NavHostController
-import androidx.navigation.compose.NavHost
-import com.mikelau.core.common.utils.PokemonFeature
+import androidx.hilt.navigation.compose.hiltViewModel
+import androidx.lifecycle.viewmodel.navigation3.rememberViewModelStoreNavEntryDecorator
+import androidx.navigation3.runtime.NavBackStack
+import androidx.navigation3.runtime.NavEntry
+import androidx.navigation3.runtime.NavKey
+import androidx.navigation3.runtime.rememberNavBackStack
+import androidx.navigation3.runtime.rememberSaveableStateHolderNavEntryDecorator
+import androidx.navigation3.ui.NavDisplay
+import com.mikelau.core.AppNavDestination
+import com.mikelau.feature.pokemon.ui.screen.PokemonScreen
+import com.mikelau.feature.pokemon.ui.screen.PokemonViewModel
+import com.mikelau.feature.pokemondetails.ui.screen.PokemonDetailsScreen
+import com.mikelau.feature.pokemondetails.ui.screen.PokemonDetailsViewModel
 
 @Composable
-fun AppNavGraph(
-    navController: NavHostController,
-    navigationProvider: NavigationProvider
-) {
-
-    NavHost(navController = navController, startDestination = PokemonFeature.nestedRoute){
-        navigationProvider.pokemonApi.registerGraph(
-            navController,this
-        )
+fun rememberAppNavBackStack(): NavBackStack<NavKey> =
+    rememberNavBackStack(AppNavDestination.PokemonList)
 
-        navigationProvider.pokemonDetailsApi.registerGraph(
-            navController,this
-        )
-    }
-}
+@Suppress("UNCHECKED_CAST")
+@Composable
+fun AppNavGraph(backStack: NavBackStack<NavKey>) {
+    val typedBackStack = backStack as NavBackStack<AppNavDestination>
+    NavDisplay(
+        backStack = typedBackStack,
+        entryDecorators = listOf(
+            rememberSaveableStateHolderNavEntryDecorator(),
+            rememberViewModelStoreNavEntryDecorator(),
+        ),
+        onBack = { typedBackStack.removeLastOrNull() },
+        entryProvider = { key ->
+            when (key) {
+                is AppNavDestination.PokemonList -> NavEntry(key) {
+                    val viewModel = hiltViewModel<PokemonViewModel>()
+                    PokemonScreen(viewModel = viewModel, backStack = typedBackStack)
+                }
+                is AppNavDestination.PokemonDetails -> NavEntry(key) {
+                    val viewModel = hiltViewModel<PokemonDetailsViewModel>()
+                    PokemonDetailsScreen(id = key.id, viewModel = viewModel, backStack = typedBackStack)
+                }
+            }
+        }
+    )
+}

app/src/main/java/com/mikelau/pokedex/navigation/NavigationProvider.kt

@@ -1,6 +1,5 @@
 plugins {
     alias(libs.plugins.androidLibrary)
-    alias(libs.plugins.kotlinAndroid)
 }
 
 android {
@@ -27,9 +26,6 @@ android {
         sourceCompatibility = JavaVersion.VERSION_17
         targetCompatibility = JavaVersion.VERSION_17
     }
-    kotlinOptions {
-        jvmTarget = "17"
-    }
     kotlin {
         jvmToolchain(17)
     }

core/common/build.gradle.kts

@@ -1,6 +1,7 @@
 plugins {
     alias(libs.plugins.androidLibrary)
-    alias(libs.plugins.kotlinAndroid)
+    alias(libs.plugins.kotlinSerialization)
+    alias(libs.plugins.compose.compiler)
 }
 
 android {
@@ -27,9 +28,6 @@ android {
         sourceCompatibility = JavaVersion.VERSION_17
         targetCompatibility = JavaVersion.VERSION_17
     }
-    kotlinOptions {
-        jvmTarget = "17"
-    }
     kotlin {
         jvmToolchain(17)
     }
@@ -39,7 +37,10 @@ dependencies {
     implementation(libs.core.ktx)
     implementation(libs.appcompat)
     implementation(libs.material)
-    implementation(libs.navigation.compose)
+    implementation(libs.kotlinx.serialization.json)
+    implementation(libs.nav3.runtime)
+    implementation(libs.nav3.ui)
+    implementation(libs.lifecycle.nav3)
     testImplementation(libs.junit)
     androidTestImplementation(libs.androidx.test.ext.junit)
     androidTestImplementation(libs.espresso.core)

core/feature/build.gradle.kts

@@ -0,0 +1,12 @@
+package com.mikelau.core
+
+import androidx.navigation3.runtime.NavKey
+import kotlinx.serialization.Serializable
+
+sealed interface AppNavDestination : NavKey {
+    @Serializable
+    data object PokemonList : AppNavDestination
+
+    @Serializable
+    data class PokemonDetails(val id: String) : AppNavDestination
+}

core/feature/src/main/java/com/mikelau/core/AppNavDestination.kt

@@ -1,13 +1,8 @@
 package com.mikelau.core
 
-import androidx.navigation.NavGraphBuilder
-import androidx.navigation.NavHostController
-
-interface FeatureApi {
-
-    fun registerGraph(
-        navController: NavHostController,
-        navGraphBuilder: NavGraphBuilder
-    )
+import androidx.navigation3.runtime.NavBackStack
+import androidx.navigation3.runtime.NavKey
 
+fun interface FeatureApi {
+    fun registerGraph(backStack: NavBackStack<NavKey>)
 }