Add Android Navigation Components library and setup

Author: enginebai

.idea/codeStyles/codeStyleConfig.xml

@@ -16,6 +16,7 @@ It helps you to create a well configured Android starter application with the mo
 6. Create your application class which extends `BaseApplication` in `:app` module, implement abstract methods and add to `AndroidManifest.xml` file.
 7. Specify your retrofit base URL in `NetworkModule.kt` file.
 8. Start to design your main layout xml file `fragment_main.xml` and fragment class.
+9. Specify your `MainFragment.kt` name in navigation graph xml file.
 9. That's all. Start your app development journey now 🎉.
 
 ## Good Practices

README.md

@@ -1,9 +1,10 @@
 plugins {
     id("com.android.application")
+    commonPlugins.forEach { id(it) }
+    id("androidx.navigation.safeargs.kotlin")
 }
 
 //apply(from = "../dependencies.gradle.kts")
-importCommonPlugins()
 configAndroid()
 importCommonDependencies()
 
@@ -15,4 +16,6 @@ android {
 
 dependencies {
     implementation(project(":base"))
+    implementation(Dependencies.Navigation.fragmentKtx)
+    implementation(Dependencies.Navigation.uiKtx)
 }

app/build.gradle.kts

@@ -1,6 +1,9 @@
 <?xml version="1.0" encoding="utf-8"?>
-<FrameLayout
-    xmlns:android="http://schemas.android.com/apk/res/android"
+<androidx.fragment.app.FragmentContainerView xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    android:id="@+id/fragmentContainer"
+    android:name="androidx.navigation.fragment.NavHostFragment"
     android:layout_width="match_parent"
     android:layout_height="match_parent"
-    android:id="@+id/fragmentContainer"/>
+    app:defaultNavHost="true"
+    app:navGraph="@navigation/nav_graph"/>

app/src/main/res/layout/activity_main.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="utf-8"?>
+<navigation xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
+    android:id="@+id/nav_graph"
+    app:startDestination="@id/fragmentMain">
+    <!-- TODO: 7. Add your content fragment and set navigation name -->
+    <fragment
+        android:id="@+id/fragmentMain"
+        tools:layout="@layout/fragment_main"
+        />
+</navigation>

app/src/main/res/navigation/nav_graph.xml

@@ -1,8 +1,8 @@
 plugins {
     id("com.android.library")
+    commonPlugins.forEach { id(it) }
 }
 
-importCommonPlugins()
 configAndroid()
 importCommonDependencies()
 

base/build.gradle.kts

@@ -9,6 +9,7 @@ buildscript {
     dependencies {
         classpath(Dependencies.androidGradlePlugin)
         classpath(Dependencies.Kotlin.gradlePlugin)
+        classpath(Dependencies.Navigation.safeArgs)
         // NOTE: Do not place your application dependencies here; they belong
         // in the individual module build.gradle files
     }

build.gradle.kts

@@ -66,14 +66,19 @@ object Dependencies {
         const val rxJava2 =
             "androidx.paging:paging-rxjava2:${Versions.ArchitectureComponents.paging}"
     }
-}
 
-fun Project.importCommonPlugins() {
-    plugins.apply("kotlin-android")
-    plugins.apply("kotlin-android-extensions")
-    plugins.apply("kotlin-kapt")
+    object Navigation {
+        const val fragmentKtx =
+            "androidx.navigation:navigation-fragment-ktx:${Versions.ArchitectureComponents.navigation}"
+        const val uiKtx =
+            "androidx.navigation:navigation-fragment-ktx:${Versions.ArchitectureComponents.navigation}"
+        const val safeArgs =
+            "androidx.navigation:navigation-safe-args-gradle-plugin:${Versions.ArchitectureComponents.navigation}"
+    }
 }
 
+val commonPlugins = arrayOf("kotlin-android", "kotlin-android-extensions", "kotlin-kapt")
+
 // apply common plugin
 fun Project.importCommonDependencies() {
     dependencies {

buildSrc/src/main/kotlin/Dependencies.kt

@@ -39,6 +39,7 @@ object Versions {
         const val lifecycle = "2.1.0"
         const val paging = "2.1.2"
         const val room = "2.2.5"
+        const val navigation = "2.3.0"
     }
 
 }