How to create a custom Navigation drawer in Kotlin with Day-Night toggle

Video 1: Learn to build the Navigation drawer header:

Video 2: Learn to build the Navigation drawer:

Video 3: Learn to add Dark-night mode to the Navigation drawer:

FirstFragment.kt

package com.nk.customnavigationdrawer

import android.os.Bundle
import androidx.fragment.app.Fragment
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup

// TODO: Rename parameter arguments, choose names that match
// the fragment initialization parameters, e.g. ARG_ITEM_NUMBER
private const val ARG_PARAM1 = "param1"
private const val ARG_PARAM2 = "param2"

/**
 * A simple [Fragment] subclass.
 * Use the [FirstFragment.newInstance] factory method to
 * create an instance of this fragment.
 */
class FirstFragment : Fragment() {
    // TODO: Rename and change types of parameters
    private var param1: String? = null
    private var param2: String? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        arguments?.let {
            param1 = it.getString(ARG_PARAM1)
            param2 = it.getString(ARG_PARAM2)
        }
    }

    override fun onCreateView(
        inflater: LayoutInflater, container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        // Inflate the layout for this fragment
        return inflater.inflate(R.layout.fragment_first, container, false)
    }

    companion object {
        /**
         * Use this factory method to create a new instance of
         * this fragment using the provided parameters.
         *
         * @param param1 Parameter 1.
         * @param param2 Parameter 2.
         * @return A new instance of fragment FirstFragment.
         */
        // TODO: Rename and change types and number of parameters
        @JvmStatic
        fun newInstance(param1: String, param2: String) =
            FirstFragment().apply {
                arguments = Bundle().apply {
                    putString(ARG_PARAM1, param1)
                    putString(ARG_PARAM2, param2)
                }
            }
    }
}

fragment_first.xml

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".FirstFragment">

    <!-- TODO: Update blank fragment layout -->
    <TextView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:text="@string/hello_blank_fragment" />

</FrameLayout>

SecondFragment.kt

package com.nk.customnavigationdrawer

import android.os.Bundle
import androidx.fragment.app.Fragment
import android.view.LayoutInflater
import android.view.View
import android.view.ViewGroup

// TODO: Rename parameter arguments, choose names that match
// the fragment initialization parameters, e.g. ARG_ITEM_NUMBER
private const val ARG_PARAM1 = "param1"
private const val ARG_PARAM2 = "param2"

/**
 * A simple [Fragment] subclass.
 * Use the [SecondFragment.newInstance] factory method to
 * create an instance of this fragment.
 */
class SecondFragment : Fragment() {
    // TODO: Rename and change types of parameters
    private var param1: String? = null
    private var param2: String? = null

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        arguments?.let {
            param1 = it.getString(ARG_PARAM1)
            param2 = it.getString(ARG_PARAM2)
        }
    }

    override fun onCreateView(
        inflater: LayoutInflater, container: ViewGroup?,
        savedInstanceState: Bundle?
    ): View? {
        // Inflate the layout for this fragment
        return inflater.inflate(R.layout.fragment_second, container, false)
    }

    companion object {
        /**
         * Use this factory method to create a new instance of
         * this fragment using the provided parameters.
         *
         * @param param1 Parameter 1.
         * @param param2 Parameter 2.
         * @return A new instance of fragment SecondFragment.
         */
        // TODO: Rename and change types and number of parameters
        @JvmStatic
        fun newInstance(param1: String, param2: String) =
            SecondFragment().apply {
                arguments = Bundle().apply {
                    putString(ARG_PARAM1, param1)
                    putString(ARG_PARAM2, param2)
                }
            }
    }
}

fragment_second.xml

<?xml version="1.0" encoding="utf-8"?>
<FrameLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".SecondFragment">

    <!-- TODO: Update blank fragment layout -->
    <TextView
        android:layout_width="match_parent"
        android:layout_height="match_parent"
        android:text="@string/hello_blank_fragment" />

</FrameLayout>

values/app_attrs.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <attr name ="drawerItemColorChecked" format="color"/>
    <attr name ="drawerItemColorNormal" format="color"/>
    <attr name ="drawerItemBackground" format="color"/>
    <attr name="drawerBackground" format="color"/>
    <attr name="navHeaderTitleColor" format="color"/>
    <attr name="navHeaderDescriptionColor" format="color"/>
</resources>

values/colors.xml

<?xml version="1.0" encoding="utf-8"?>
<resources>
    <color name="orange_500">#ff9800</color>
    <color name="orange_600">#fb8c00</color>

    <color name="gray_100">#F5F5F5</color>
    <color name="gray_200">#EEEEEE</color>
    <color name="gray_800">#424242</color>
    <color name="gray_900">#757575</color>

    <color name="yellow_500">#ffeb3b</color>
    <color name="yellow_800">#F9A825</color>

    <color name="white">#ffffff</color>

    <color name="blue_gray_700">#455A64</color>
    <color name="blue_gray_900">#263238</color>
</resources>

values/string.xml

<resources>
    <string name="app_name">CustomNavigationDrawer</string>
    <!-- TODO: Remove or change this placeholder text -->
    <string name="hello_blank_fragment">Hello blank fragment</string>
</resources>

values/themes.xml

<resources xmlns:tools="http://schemas.android.com/tools">
    <!-- Base application theme. -->
    <style name="Theme.CustomNavigationDrawer" parent="Theme.MaterialComponents.DayNight.NoActionBar">
        <!-- Primary brand color. -->
        <item name="colorPrimary">@color/orange_600</item>
        <item name="colorPrimaryVariant">@color/orange_600</item>
        <!-- Status bar color. -->
        <item name="android:statusBarColor" tools:targetApi="l">?attr/colorPrimaryVariant</item>
        <!-- Customize your theme here. -->

        <item name="drawerItemColorChecked">@color/yellow_500</item>
        <item name="drawerItemColorNormal">@color/gray_900</item>
        <item name="drawerItemBackground">@color/gray_800</item>
        <item name="drawerBackground">@color/white</item>
        <item name="navHeaderTitleColor">@color/gray_900</item>
        <item name="navHeaderDescriptionColor">@color/gray_800</item>
    </style>

    <style name="Theme.NavigationDrawer" parent="ThemeOverlay.MaterialComponents.Light">
        <item name="android:scrollbarThumbVertical">@android:color/transparent</item>
        <item name="colorControlHighlight">@color/yellow_500</item>
        <item name="colorPrimary">@color/orange_500</item>
    </style>
</resources>

values-night/themes.xml

<resources xmlns:tools="http://schemas.android.com/tools">
    <!-- Base application theme. -->
    <style name="Theme.CustomNavigationDrawer" parent="Theme.MaterialComponents.DayNight.NoActionBar">
        <!-- Primary brand color. -->
        <item name="colorPrimary">@color/gray_900</item>
        <item name="colorPrimaryVariant">@color/gray_900</item>
        <!-- Status bar color. -->
        <item name="android:statusBarColor" tools:targetApi="l">?attr/colorPrimaryVariant</item>
        <!-- Customize your theme here. -->

        <item name="drawerItemColorChecked">@color/orange_600</item>
        <item name="drawerItemColorNormal">@color/gray_100</item>
        <item name="drawerItemBackground">@color/blue_gray_700</item>
        <item name="drawerBackground">@color/blue_gray_900</item>
        <item name="navHeaderTitleColor">@color/gray_100</item>
        <item name="navHeaderDescriptionColor">@color/gray_200</item>
    </style>

    <style name="Theme.NavigationDrawer" parent="ThemeOverlay.MaterialComponents.Light">
        <item name="android:scrollbarThumbVertical">@android:color/transparent</item>
        <item name="colorControlHighlight">@color/yellow_500</item>
        <item name="colorPrimary">@color/orange_500</item>
    </style>
</resources>

You can see that we are using different colors with same item name in both themes.

res/color/drawer_item_text_icon.xml

<?xml version="1.0" encoding="utf-8"?>
<selector xmlns:android="http://schemas.android.com/apk/res/android">
    <item android:color="?attr/drawerItemColorChecked" android:state_checked="true" />
    <item android:color="?attr/drawerItemColorNormal" />
</selector>

icon:

It has only one icon, a drawable to show for the user profile image. It is avatar.png

drawer_item_bg.xml

It is the background for the navigation drawer items if it is selected.

<?xml version="1.0" encoding="utf-8"?>
<shape xmlns:android="http://schemas.android.com/apk/res/android"
    android:shape="rectangle">
<solid android:color="?attr/drawerItemBackground"/>
</shape>

It picks different color for day and night mode

drawer_item_selector.xml

<?xml version="1.0" encoding="utf-8"?>
<selector xmlns:android="http://schemas.android.com/apk/res/android">
<item android:state_checked="true" android:drawable="@drawable/drawer_item_bg"/>
</selector>

Background for each drawer item. It shows drawer_item_bg for selected items.

icons:

There are eight icons to show with the drawer items:

ic_adb.xml
ic_inbox.xml
ic_alarm.xml
ic_bedtime.xml
ic_amp.xml
ic_cloud.xml
ic_home.xml
ic_reaction.xml

ic_nav_background.xml:

It is the background for the navigation header.

<vector xmlns:android="http://schemas.android.com/apk/res/android"
    android:width="1440dp"
    android:height="320dp"
    android:viewportWidth="1440"
    android:viewportHeight="320">
  <path
      android:pathData="M0,160L120,165.3C240,171 480,181 720,208C960,235 1200,277 1320,298.7L1440,320L1440,0L1320,0C1200,0 960,0 720,0C480,0 240,0 120,0L0,0Z"
      android:fillColor="#9e9e9e"/>
</vector>

It is a vector asset.

navbar_background.xml

This is the header of the navigation drawer.

<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:background="@drawable/ic_nav_background">
    <de.hdodenhof.circleimageview.CircleImageView
        xmlns:app="http://schemas.android.com/apk/res-auto"
        android:id="@+id/profile_image"
        android:layout_width="0dp"
        android:layout_height="0dp"
        android:src="@drawable/avatar"
        android:layout_marginLeft="10dp"
        android:layout_marginTop="10dp"
        android:scaleType="centerCrop"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
        app:layout_constraintWidth_percent="0.35"
        app:layout_constraintDimensionRatio="1:1"
        />
    <TextView
        android:id="@+id/user_name"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Mr. XYZ"
        android:textAppearance="@style/TextAppearance.AppCompat.Headline"
        android:textColor="?attr/navHeaderTitleColor"
        app:layout_constraintTop_toBottomOf="@+id/profile_image"
        app:layout_constraintLeft_toLeftOf="@+id/profile_image"
        android:layout_marginTop="5dp"/>
    <TextView
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:text="Manage your profile"
        android:textAppearance="@style/TextAppearance.AppCompat.Body1"
        android:textColor="?attr/navHeaderDescriptionColor"
        app:layout_constraintTop_toBottomOf="@+id/user_name"
        app:layout_constraintLeft_toLeftOf="@+id/user_name"
        android:layout_marginTop="5dp"
        android:layout_marginBottom="10dp"/>
</androidx.constraintlayout.widget.ConstraintLayout>

It adds the profile image and two texts below it.