Material NavigationView for Android 📱

📱 Android Library to implement Rich, Beautiful Material Navigation View for your project with Material Design Guidelines. Easy to use.

Table of Contents:

• Introduction
• Requirements

• Implementation

  • Prerequisite
  • Create

    Activity.xml

  • Create Activity File

• Migrating from

  NavigationView

• Fast Implementation

• Contribute

• Credits

• License

Introduction

MaterialNavigationView library is built upon Google's Material Design library. This API will be useful to create rich, animated, beautiful Navigation View Drawer in Android app easily. It follows all Material Design Guidelines as stated here.

MaterialNavigationView

com.google.android.material.navigation.NavigationView

Requirements

• AndroidX
• Minimum SDK API 19
• Theme - Material Components

Implementation

Implementation of Material Navigation View library is so easy. You can check /app directory for demo. Let's have look on basic steps of implementation. In this demo, we will populate The menu contents by a menu resource file.

Prerequisite

Gradle

In

Build.gradle

// Material Navigation View Library
implementation 'com.shreyaspatil:MaterialNavigationView:1.2'

// Material Design Library
implementation 'com.google.android.material:material:1.0.0'

} ```

Set up Material Theme

Setting Material Theme to app is necessary before implementing Material Navigation View library. To set it up, update

styles.xml

values

colorSecondary

Create Activity XML

This is most commonly used in conjunction with

DrawerLayout

(R.menu.)

activity_main.xml

<com.shreyaspatil.material.navigationview.materialnavigationview android:id="@+id/nav_view" android:theme="@style/Widget.NavigationView.RippleEffect" android:layout_width="wrap_content" android:layout_height="match_parent" app:itemstyle="rounded_right" app:menu="@menu/activity_main_drawer"></com.shreyaspatil.material.navigationview.materialnavigationview>

Available Flags

As already mentioned, this class is inherited from

NavigationView

itemStyle

Flag Value	Description	Preview
defaultstyle	This flag sets design to default style to menu item of Navigation drawer.
roundedright	This flag sets design to menu item of Navigation drawer as Rounded Corners at right
rounded_rectangle	This flag sets design to menu item of Navigation drawer as Rounded Rectangular Corners

Example as follows:

Thus, we have successfully implemented design styles of Menu items.

Create Activity Code (Java/Kotlin)

All the programmatic way of implementation of

MaterialNavigationView

NavigationView

setItemStyle(int itemStyle)

itemStyle

MaterialNavigationView.ITEM_STYLE_DEFAULT

MaterialNavigationView.ITEM_STYLE_ROUND_RIGHT

MaterialNavigationView.ITEM_STYLE_ROUND_RECTANGLE

getItemStyle()

Here is a demo of

MaterialNavigationView

class MainActivity : AppCompatActivity() {
    private lateinit var navView: MaterialNavigationView

override fun onCreate(savedInstanceState: Bundle?) {
    super.onCreate(savedInstanceState)
    setContentView(R.layout.activity_main)
    ...
    navView = findViewById(R.id.nav_view)
    ...
}

override fun onOptionsItemSelected(item: MenuItem): Boolean {
    when (item.itemId) {
        R.id.action_default -> {
            navView.setItemStyle(MaterialNavigationView.ITEM_STYLE_DEFAULT)
        }
        R.id.action_round_rect -> {
            navView.setItemStyle(MaterialNavigationView.ITEM_STYLE_ROUND_RECTANGLE)
        }
        R.id.action_round_right -> {
            navView.setItemStyle(MaterialNavigationView.ITEM_STYLE_ROUND_RIGHT)
        }
    }
    return false
}
}

Thus, we have implemented

MaterialNavigationView

Migrating from

NavigationView

If you are already using

NavigationView

com.google.android.material.navigation.NavigationView

MaterialNavigationView

com.google.android.material.navigation.NavigationView

com.shreyaspatil.material.navigationview.MaterialNavigationView

NavigationView

MaterialNavigationView

:fire: Hurrah! you are done and successfully migrated to

MaterialNavigationView

Fast Implementation

Want to use it fast? Then here it is..
In Android Studio, Right Click ->

New

Activity

Navigation Drawer Activity

Contribute

Let's develop with collaborations. We would love to have contributions by raising issues and opening PRs. Filing an issue before PR is must. If you have design/UI related idea, you can also do contributions in that. See Contributing Guidelines.

Credits

This library is built using following open-source libraries. - Material Components for Android

If you like this library, Please start this repo and share with someone who need it. You can contribute if you have any suggestions or ideas to improve it.

License

Project is published under the GPL-3.0 license. Feel free to clone and modify repo as you want, but don't forget to add reference to authors :)