- Android Navigation Drawer Explained [Step By Step]
- Navigation drawer with Material Design
- Steps to create Navigation drawer in material Design,
- Step 1 — Add material design dependency
- Step 2 — Setup DrawerLayout
- Important Methods Of Drawer Layout
- Step 3 -Setup NavigationView
- Step 4 — Selecting fragment for the navigation menu Item
- Bonus
- Navigation Drawer without Toolbar / Actionbar
- More on Material Design
- How to Code a Navigation Drawer for an Android App
- Prerequisites
- Create an Android Studio Project
- Add Project Dependencies
- Create the DrawerLayout
- Create a Navigation Graph
- Add NavHostFragment
- Add Fragments to the Destination Graph
- Add a NavigationView Component
- Initialization of Components
- Testing the App
- Bonus: Using Android Studio Templates
- Top Android App Templates With Navigation Drawers From CodeCanyon
- Grocery and Vegetable Delivery Android App with Admin Panel
- Universal: Full Multi-Purpose Android App
- MaterialX: Android Material Design UI Components 2.7
- Universal Android WebView App
- Android Wallpapers App
- Conclusion
Android Navigation Drawer Explained [Step By Step]
Navigation drawer used to navigate many screens or functionalities of the app by clicking on the ‘hamburger’ icon. Swiping from the left is also a way to bring the drawer into view, a screen then slides in, showing many items. You can click on these said items and go to those screens to use that feature of the app.
Android Navigation drawer official document says,
Navigation drawers provide access to destinations and app functionality, such as switching accounts. They can either be permanently on-screen or controlled by a navigation menu icon.
Navigation drawers are recommended for:
- Apps with five or more top-level destinations
- Apps with two or more levels of navigation hierarchy
- Quick navigation between unrelated destinations
Navigation drawer with Material Design
Navigation drawer is part of the material design. So, by including the material dependency, you can access the navigation drawer.
This is my android navigation drawer application demo,
lets create sample application on android navigation drawer using material design.
Steps to create Navigation drawer in material Design,
- Add material design dependency.
- Setup DrawerLayout.
- Setup NavigationView.
- Selecting fragment for the navigation menu Item.
Lets see the every step in details.
Step 1 — Add material design dependency
As mentioned above, drawer layout part of the material design. So lets add the material design dependency.
Step 2 — Setup DrawerLayout
In Android, DrawerLayout acts as a top-level container for window content that allows for interactive “drawer” views to be pulled out from one or both vertical edges of the window. Drawer position and layout is controlled by using the layout_gravity attribute on child views corresponding to which side of view we want the drawer to emerge from like left to right.
Also, under the DrawerLayout we need to add AppBarLayout for the Toolbar and the Fragment viewholder the FrameLayout.
Once created the layout files, Create ActionBarDrawerToggle for the drawerLayout listener.
ActionBarDrawerToggle: This is used with a DrawerLayout to implement the recommended functionality of Navigation Drawers. It has the following usages:
- Acts as a listener, for opening and closing of drawers.
- Provides the hamburger icons in the ToolBar/ActionBar.
- It allows for the animation between the hamburger icon and the arrow to exist.
addDrawerListener(toggle): This listener is used to keep notified of drawer events.
syncState(): will synchronize the icon’s state and display the hamburger icon or back arrow depending on whether the drawer is closed or open. Omitting this line of code won’t change the back arrow to the hamburger icon when the drawer is closed.
Important Methods Of Drawer Layout
closeDrawer(int gravity): Close the drawer view by animating it into view. We can close a drawer by passing END gravity to this method.
closeDrawers(): Close all the currently open drawer views by animating them out of view. We mainly use this method on click of any item of Navigation View.
isDrawerOpen(int drawerGravity): Used to check the drawer view is currently open or not. It returns true if the drawer view is open otherwise it returns false.
isDrawerVisible(int drawerGravity): Used to check the drawer view is currently visible on screen or not. It returns true if the drawer view is visible otherwise it returns false.
openDrawer(int gravity): Open the drawer view by animating it into view. We can open a Drawer by passing START gravity to this method.
Step 3 -Setup NavigationView
NavigationView is an easy way to display a navigation menu from a menu resource.
This is most commonly used in conjunction with DrawerLayout to implement Material navigation drawers. Navigation drawers are modal elevated dialogs that come from the start/left side, used to display in-app navigation links.
The NavigationView essentially consists of two major components,
This View is typically displayed at the top of the Navigation Drawer. It essentially holds the profile picture, name email address, and a background cover pic. This view is defined in a separate layout file that we’ll look at in a bit.
After finishing creating the header we need to create a menu resource file that will hold the items to be displayed in the drawer. Here’s how to create the menu resource file:
Right-click the res folder →Select new →Android resource file →Choose ‘menu’ under the resource type drop-down list.
Name the file as ‘ activity_main_drawer.xml’ and copy-paste the following code into the file.
Important Methods Of NavigationView
setNavigationItemSelectedListener(NavigationView.OnNavigationItemSelectedListener listener):This method is used to set a listener that will be notified when a menu item is selected.
Step 4 — Selecting fragment for the navigation menu Item
In your Activity implement the NavigationView.OnNavigationItemSelectedListener and override the onNavigationItemSelected(MenuItem item).By using the MenuItem Id we can able to launch the correct Fragment.
Display The Default Fragment
In the OnCreate() By default, we need to display the default Fragment. For that, we need to use
And Also need to start the fragment for the same,
Bonus
Navigation Drawer without Toolbar / Actionbar
Above, we have the example to create the navigation drawer with the toolbar. From that, we need to remove the toolbar layout and supportActionbar to create navigation drawer without Toolbar / Actionbar.
Delete AppBarLayout from your app_bar_main.xml
delete Toolbar from ActionBarDrawerToggle your MainActivity.java
Now you can see that Toolbar gone invisible.
That’s it. Now we created the Navigation drawer with material Design. You can download the example in github.
More on Material Design
Also, I have explained Snackbar android in material design.
Источник
How to Code a Navigation Drawer for an Android App
The Material Design team at Google defines the functionality of a navigation drawer in Android as follows:
The navigation drawer slides in from the left and contains the navigation destinations for your app.
An example of a popular Android app that implements the navigation drawer menu design is the Inbox app from Google, which uses a navigation drawer to navigate different application sections. You can check it yourself by downloading the Inbox app from the Google Play store if you don’t already have it on your device. The screenshot below shows Inbox with the navigation drawer pulled open.
The user can view the navigation drawer when they swipe a finger from the left edge of the activity. They can also find it from the home activity (the top level of the app) by tapping the app icon (also known as the Android «hamburger» menu) in the action bar.
Note that if you have many different destinations (more than six, say) in your app, it’s recommended that you use a navigation drawer menu design.
In this post, you’ll learn how to display navigation items inside a navigation drawer in Android. We’ll cover how to use Jetpack navigation to perform this task. As a bonus, you’ll also learn how to use the Android Studio templates feature to bootstrap your project with a navigation drawer quickly.
Prerequisites
To be able to follow this Android Studio navigation drawer tutorial, you’ll need:
Create an Android Studio Project
Fire up Android Studio and create a new project (you can name it NavigationDrawer ) with an empty activity called MainActivity . Make sure to also choose the Kotlin language.
Add Project Dependencies
Support for navigation requires some dependencies. Open the app build.gradle file and add the following dependencies.
Also add the material library to the project.
Sync the project files for the changes to take effect.
Create the DrawerLayout
To display the drawer icon on all destinations in our app, we will use the DrawerLayout component. Open main_acivity.xml and add DrawerLayout as the root view. The drawer layout will host two child views, NavHostFragment and NavigationView .
Here we created a DrawerLayout widget with the id drawer_layout . The tools:openDrawer property is used to display the navigation drawer toggle when the XML layout is open in Android Studio design view.
The official documentation says the following about DrawerLayout :
DrawerLayout acts as a top-level container for window content that allows for interactive «drawer» views to be pulled out from one or both vertical edges of the window.
After adding the DrawerLayout widget, we included a child layout, app_bar_main.xml which points to the toolbar layout.
Here is my app_bar_main.xml resource file. This file has a CoordinatorLayout , an AppBarLayout , and a Toolbar widget.
Create a Navigation Graph
A navigation graph is an XML resource file that contains all of your app’s destinations and actions, and these destinations are connected via actions. Below is an example of a navigation graph showing five fragments.
Enter Nav graph showing 5 screens
To add a navigation graph, right-click on the res directory and select New > Android Resource File. In the next dialog, select Navigation as the Resource Type, and click OK. A new XML file, nav_graph.xml, will be created in the Navigation folder, as shown below.
Create navigation graph
Add NavHostFragment
A navigation host fragment acts as a host for the app’s fragments and swaps fragments in and out as necessary when the user moves from one destination to the other. These destinations have to be defined in the navigation graph.
Add NavHostFragment to the main_activity.xml file and reference the navGraph .
Add Fragments to the Destination Graph
Fragments represent all the destinations of your app. In our case, we will add three fragments to the navigation graph. Right-click the navigation folder and open nav_graph.xml. To add a fragment, click on Create New Destination and fill out the rest of the details.
Add fragment to navigation graph
Repeat the same steps and create two additional fragments, the profile fragment and the settings fragment. Your navigation graph should now look like this.
Add a NavigationView Component
Finally, let’s create a NavigationView widget. The official documentation says the following about NavigationView :
NavigationView represents a standard navigation menu for application. The menu contents can be populated by a menu resource file.
Open main_activity.xml and add the NavigationView .
In the NavigationView XML widget, you can see that we added an android:layout_gravity attribute with the value start . This is used to position the drawer—you want the navigation drawer menu design to come out from the left or right (the start or end on platform versions that support layout direction). In our own case, the drawer will come out from the left.
We also included an app:headerLayout attribute, which points to @layout/nav_header_main . This will add a View as a header of the navigation menu.
Here is my nav_header_main.xml layout resource file:
To include the menu items for the navigation drawer, we can use the attribute app:menu with a value that points to a menu resource file.
Here is the res/menu/drawer_menu.xml menu resource file:
Here we have defined a Menu using the which serves as a container for menu items. An creates a MenuItem , which represents a single item in a menu. It’s also important to note that the ids of the menu items correspond to the ids of the matching fragment.
Note that when showing the navigation list items from a menu resource, we could use a ListView instead. But, by configuring the navigation drawer with a menu resource, we get the material design styling on the navigation drawer for free! If you used a ListView , you’d have to maintain the list and also style it to meet the recommended material design specs for the navigation drawer.
Initialization of Components
Next, we are going to initialize instances of all our components. Initialization is going to happen inside onCreate() in MainActivity.kt.
The AppBarConfiguration object is used to manage the behavior of the navigation drawer button.
First, we use the setSupportActionBar() method to set the toolbar as the app bar for the activity.
Next, we set all fragments as top-level destinations, this means that they will remain in the back stack when navigating.
The method setupActionBarWithNavController automatically updates the title in the action bar when the destination changes.
Set up the navigation drawer.
Lastly, show the up button that appears at the top left of the app bar. This is done by integrating the navigation controller withe app bar using the onSupportNavigateUp method.
The final code for MainActivity.kt should look like this.
Testing the App
At this point, we can run the app!
Bonus: Using Android Studio Templates
Now that you’ve learnt about the APIs involved to create a navigation drawer, I’ll show you a shortcut that will make it faster next time. You can simply use a template instead of coding a navigation drawer Activity from scratch.
Android Studio provides code templates that follow the Android design and development best practices. These existing code templates (available in Java and Kotlin) can help you quickly kick-start your project. One such template can be used to create a navigation drawer activity.
I’ll show you how to use this handy feature in Android Studio.
For a new project, fire up Android Studio.
Enter the application name and click the Next button.
You can leave the defaults as they’re in the Target Android Devices dialog. Click the Next button again.
In the Add an Activity to Mobile dialog, scroll down and select Navigation Drawer Activity. Click the Next button after that.
In the last dialog, you can rename the Activity name, layout name, or title if you want. Finally, click the Finish button to accept all configurations.
Android Studio has now helped us to create a project with a navigation drawer activity. Really cool! You’re strongly advised to explore the code generated.
You can use templates for an already existing Android Studio project too. Simply go to File > New > Activity > Navigation Drawer Activity.
Top Android App Templates With Navigation Drawers From CodeCanyon
The templates that come included with Android Studio are good for simple layouts and making basic apps, but if you want to kick-start your app even further, you might consider some of the app templates available from Envato Market.
They’re a huge time-saver for experienced developers, helping them to cut through the slog of creating an app from scratch and focus their talents instead on the unique and customised parts of creating a new app.
Here are just a small handful of the thousands of Android app templates available on CodeCanyon. If there’s one that piques your interest, you can easily get started by making a purchase.
Grocery and Vegetable Delivery Android App with Admin Panel
If you or your client have a food delivery business, getting an app up and running is crucial. That’s why you should consider this multi-store grocery service app template. It includes three templates with stunning layouts and Android hamburger menus. There’s no limit to the categories you can add, and you can also use SMS and email order notifications.
Universal: Full Multi-Purpose Android App
Buying the Universal Android app template is just like downloading a Swiss Army knife. It can do it all, from WordPress and Facebook to Twitter and SoundCloud. In fact, there is a list of more than 15 content providers that this template supports. Users can access important information from the slick side menu design and easily make their way around their favorite sites.
MaterialX: Android Material Design UI Components 2.7
MaterialX is a recommended download for any app developer. It includes more than 315 unique UI components across more than 31 categories. Create stunning Android side menu designs, buttons, dialog boxes, and more from this single download. If you want a quick way to add some much-needed style to your new project, get this template.
Universal Android WebView App
Do you have content hosted online that you want to turn into a mobile experience? Then check out the Universal Android WebView App template. It was developed in Android Studio and supports phones and tablets running Android 4.1 and above. The Android navigation drawer menu design is completely customizable, as are other components. It also supports AdMob for monetization.
Android Wallpapers App
Here’s a cool Android app template that’s useful if you want to get your creative designs out into the world. The Android Wallpapers app supports static images, GIFs, and 4K photos. This template also includes useful features like:
- pinch to zoom
- push notifications
- AdMob advertisement support
- Android Studio code
Conclusion
In this tutorial, you learned how to create a navigation drawer menu design in Android from scratch, using Jetpack navigation. We also explored how easy and quick it is to use Android Studio templates to create a navigation drawer.
I highly recommend checking out the official material design guidelines for navigation drawers to learn more about how to properly design and use navigation drawers in Android.
To learn more about coding for Android, check out some of our other courses and tutorials here on Envato Tuts+!
This post has been updated with contributions from Nathan Umoh. Nathan is a staff writer for Envato Tuts+.
Источник