#MaterialDrawer

Does your application contain a Drawer? Do you want to have it up and running in less than 5 minutes? Do you want your drawer to follow the Android Design Guidelines? Do you have profiles? Do you need flexibility? Is Google's navigation Drawer of the design support not enough for you? Do you want a simple and easy to understand api?

If any (or all) of these questions seem familiar, the MaterialDrawer is the perfect library for you.

Never waste your time again. It provides you with the easiest possible implementation of a navigation drawer for your application. There is a Header with profiles (AccountHeader), a MiniDrawer for Tablets (like Gmail), provide custom DrawerItems, custom colors, custom themes, ... No limits for customizations.

###A quick overview what's in

• the easiest possible integration
• integrate in less than 5 minutes
• compatible down to API Level 10
• includes an AccountSwitcher
• quick and simple api
• follows the Google Material Design Guidelines
• use vector (.svg) icons and icon fonts via the Android-Iconics integration
• Google Material Design Icons, Google Material Community Design Icons, FontAwesome and more
• comes with various themes which help to get your own themes clean
• modify the colors on the go
• uses the AppCompat support library
• comes with multiple default drawer items
• based on a RecyclerView
• RTL support
• Gmail like MiniDrawer
• expandable items
• badge support
• define custom drawer items
• tested and stable
• sticky footer or headers
• absolutely NO limits

If you upgrade from < 5.0.0 follow the MIGRATION GUIDE

#Preview ##Demo You can try it out here Google Play (wall:splash an open source application which uses this drawer implementation). Or you try the Sample Application

##Screenshots

#WIKI / FAQ You can find some frequently asked questions and other resources in the WIKI / FAQ site.

#Setup ##1. Provide the gradle dependency

compile('com.mikepenz:materialdrawer:5.3.6@aar') {
	transitive = true
}

##2. Add your drawer

new DrawerBuilder().withActivity(this).build();

Great. Your drawer is now ready to use.

#Additional Setup ##Add items and adding some functionality

//if you want to update the items at a later time it is recommended to keep it in a variable
PrimaryDrawerItem item1 = new PrimaryDrawerItem().withIdentifier(1).withName(R.string.drawer_item_home);
SecondaryDrawerItem item2 = new SecondaryDrawerItem().withIdentifier(2).withName(R.string.drawer_item_settings);

//create the drawer and remember the `Drawer` result object
Drawer result = new DrawerBuilder()
    .withActivity(this)
    .withToolbar(toolbar)
    .addDrawerItems(
	    item1,
	    new DividerDrawerItem(),
	    item2,
	    new SecondaryDrawerItem().withName(R.string.drawer_item_settings)
    )
    .withOnDrawerItemClickListener(new Drawer.OnDrawerItemClickListener() {
        @Override
        public boolean onItemClick(View view, int position, IDrawerItem drawerItem) {
    	    // do something with the clicked item :D
        }
    })
    .build();

##Selecting an item

//set the selection to the item with the identifier 1
result.setSelection(1);
//set the selection to the item with the identifier 2
result.setSelection(item2);
//set the selection and also fire the `onItemClick`-listener
result.setSelection(1, true);

By default, when a drawer item is clicked, it becomes the new selected item. If this isn't the expected behavior, you can disable it for this item using withSelectable(false):

new SecondaryDrawerItem().withName(R.string.drawer_item_dialog).withSelectable(false)

##Modify items or the drawer

//modify an item of the drawer
item1.withName("A new name for this drawerItem").withBadge("19").withBadgeStyle(new BadgeStyle().withTextColor(Color.WHITE).withColorRes(R.color.md_red_700));
//notify the drawer about the updated element. it will take care about everything else
result.updateItem(item1);

//to update only the name, badge, icon you can also use one of the quick methods
result.updateName(1, "A new name");

//the result object also allows you to add new items, remove items, add footer, sticky footer, ..
result.addItem(new DividerDrawerItem());
result.addStickyFooterItem(new PrimaryDrawerItem().withName("StickyFooterItem"));

//remove items with an identifier
result.removeItem(2);

//open / close the drawer
result.openDrawer();
result.closeDrawer();

//get the reference to the `DrawerLayout` itself
result.getDrawerLayout();

##Add profiles and an AccountHeader

// Create the AccountHeader
AccountHeader headerResult = new AccountHeaderBuilder()
	.withActivity(this)
    .withHeaderBackground(R.drawable.header)
	.addProfiles(
		new ProfileDrawerItem().withName("Mike Penz").withEmail("[email protected]").withIcon(getResources().getDrawable(R.drawable.profile))
	)
    .withOnAccountHeaderListener(new AccountHeader.OnAccountHeaderListener() {
		@Override
		public boolean onProfileChanged(View view, IProfile profile, boolean currentProfile) {
		    return false;
		}
	})
	.build();

//Now create your drawer and pass the AccountHeader.Result
new DrawerBuilder()
    .withAccountHeader(headerResult)
    //additional Drawer setup as shown above
    ...
    .build();

##Use the included icon font The MaterialDrawer comes with the core of the Android-Iconics library. This allows you to create your DrawerItems with an icon from any font.

Choose the fonts you need. Available Fonts build.gradle

compile 'com.mikepenz:google-material-typeface:x.y.z@aar' //Google Material Icons
compile 'com.mikepenz:fontawesome-typeface:x.y.z@aar'     //FontAwesome

java

//now you can simply use any icon of the Google Material Icons font
new PrimaryDrawerItem().withIcon(GoogleMaterial.Icon.gmd_wb_sunny)
//Or an icon from FontAwesome
new SecondaryDrawerItem().withIcon(FontAwesome.Icon.faw_github)

#Advanced Setup ##Activity with ActionBar ###Code:

new DrawerBuilder()
	.withActivity(this)
	.withTranslucentStatusBar(false)
    .withActionBarDrawerToggle(false)
	.addDrawerItems(
		//pass your items here
	)
	.build();

##Activity with Multiple Drawers ###Code:

Drawer result = new DrawerBuilder()
	.withActivity(this)
	.withToolbar(toolbar)
	.addDrawerItems(
		//pass your items here
	)
	.build();

new DrawerBuilder()
	.withActivity(this)
    .addDrawerItems(
    	//pass your items here
    )
    .withDrawerGravity(Gravity.END)
    .append(result);

##Load images via url The MaterialDrawer supports fetching images from URLs and setting them for the Profile icons. As the MaterialDrawer does not contain an ImageLoading library the dev can choose his own implementation (Picasso, Glide, ...). This has to be done, before the first image should be loaded via URL. (Should be done in the Application, but any other spot before loading the first image is working too)

• SAMPLE using PICASSO
• SAMPLE using GLIDE

###Code:

//initialize and create the image loader logic
DrawerImageLoader.init(new AbstractDrawerImageLoader() {
    @Override
    public void set(ImageView imageView, Uri uri, Drawable placeholder) {
        Picasso.with(imageView.getContext()).load(uri).placeholder(placeholder).into(imageView);
    }

    @Override
    public void cancel(ImageView imageView) {
        Picasso.with(imageView.getContext()).cancelRequest(imageView);
    }

    /*
    @Override
    public Drawable placeholder(Context ctx) {
        return super.placeholder(ctx);
    }

    @Override
    public Drawable placeholder(Context ctx, String tag) {
        return super.placeholder(ctx, tag);
    }
    */
});

An implementation with GLIDE can be found in the sample application

##Switching between Back-Arrow or Hamburger-Icon If you use the included ActionBarDrawerToggle you can switch between back-arrow or hamburger-icon with the following code snippet. (Please note that the order of these lines matter) ###Code - Show the back arrow:

result.getActionBarDrawerToggle().setDrawerIndicatorEnabled(false);
getSupportActionBar().setDisplayHomeAsUpEnabled(true);

###Code - Show the hamburger icon:

getSupportActionBar().setDisplayHomeAsUpEnabled(false);
result.getActionBarDrawerToggle().setDrawerIndicatorEnabled(true);

##AndroidManifest.xml The MaterialDrawer requires an AppCompat theme or a derivative theme like the MaterialDrawerThemes as base. It is highly recommended to use one of the provided themes. They all use the AppCompat theme as parent and define the color values for the drawer.

NOTE: The theme states ActionBar and not NoActionBar like the Appcompat style

• MaterialDrawerTheme (extends Theme.AppCompat.NoActionBar)
• MaterialDrawerTheme.TranslucentStatus
• MaterialDrawerTheme.ActionBar (extends Theme.AppCompat)
• MaterialDrawerTheme.ActionBar.TranslucentStatus
• MaterialDrawerTheme.Light (extends Theme.AppCompat.Light.NoActionBar)
• MaterialDrawerTheme.Light.TranslucentStatus
• MaterialDrawerTheme.Light.ActionBar (extends Theme.AppCompat.Light)
• MaterialDrawerTheme.Light.ActionBar.TranslucentStatus
• MaterialDrawerTheme.Light.DarkToolbar (extends Theme.AppCompat.DarkActionBar) (disabled the ActionBar)
• MaterialDrawerTheme.Light.DarkToolbar.TranslucentStatus
• MaterialDrawerTheme.Light.DarkToolbar.ActionBar (extends Theme.AppCompat.DarkActionBar)
• MaterialDrawerTheme.Light.DarkToolbar.ActionBar.TranslucentStatus

##Style the drawer

Use of a none MaterialDrawer.* style

If you don't use one of the provided styles you have to add the style values to your style. Here's a simple sample. This is the same as the Custom style just with a parent like parent="Theme.AppCompat.Light.DarkActionBar"

Custom style - styles.xml

Create your custom style and use one of the provided themes as parent. If you don't need a custom theme see the next section, how you can set the colors just by overwriting the original colors.

    <style name="CustomTheme" parent="MaterialDrawerTheme">
        <!-- ...and here we setting appcompat’s color theming attrs -->
        <item name="colorPrimary">@color/material_drawer_primary</item>
        <item name="colorPrimaryDark">@color/material_drawer_primary_dark</item>
        <item name="colorAccent">@color/material_drawer_accent</item>

        <!-- MaterialDrawer specific values -->
        <item name="material_drawer_background">@color/material_drawer_background</item>
        <item name="material_drawer_primary_text">@color/material_drawer_primary_text</item>
        <item name="material_drawer_primary_icon">@color/material_drawer_primary_icon</item>
        <item name="material_drawer_secondary_text">@color/material_drawer_secondary_text</item>
        <item name="material_drawer_hint_text">@color/material_drawer_hint_text</item>
        <item name="material_drawer_divider">@color/material_drawer_divider</item>
        <item name="material_drawer_selected">@color/material_drawer_selected</item>
        <item name="material_drawer_selected_text">@color/material_drawer_selected_text</item>
        <item name="material_drawer_header_selection_text">@color/material_drawer_header_selection_text</item>
    </style>

Custom colors - colors.xml

No need to create a custom theme. Just set these colors (or some of them) and you have your own style.

	<!-- Material DEFAULT colors -->
    <color name="material_drawer_primary">#2196F3</color>
    <color name="material_drawer_primary_dark">#1976D2</color>
    <color name="material_drawer_primary_light">#BBDEFB</color>
    <color name="material_drawer_accent">#FF4081</color>
    
    <!-- OVERWRITE THESE COLORS FOR A LIGHT THEME -->
    <!-- MaterialDrawer DEFAULT colors -->
    <color name="material_drawer_background">#F9F9F9</color>
    <!-- Material DEFAULT text / items colors -->
    <color name="material_drawer_primary_text">#DE000000</color>
    <color name="material_drawer_primary_icon">#8A000000</color>
    <color name="material_drawer_secondary_text">#8A000000</color>
    <color name="material_drawer_hint_text">#42000000</color>
    <color name="material_drawer_divider">#1F000000</color>
    <!-- Material DEFAULT drawer colors -->
    <color name="material_drawer_selected">#E8E8E8</color>
    <color name="material_drawer_selected_text">#2196F3</color>
    <color name="material_drawer_header_selection_text">#FFF</color>
    
    <!-- OVERWRITE THESE COLORS FOR A DARK THEME -->
    <!-- MaterialDrawer DEFAULT DARK colors -->
    <color name="material_drawer_dark_background">#303030</color>
    <!-- MaterialDrawer DEFAULT DARK text / items colors -->
    <color name="material_drawer_dark_primary_text">#DEFFFFFF</color>
    <color name="material_drawer_dark_primary_icon">#8AFFFFFF</color>
    <color name="material_drawer_dark_secondary_text">#8AFFFFFF</color>
    <color name="material_drawer_dark_hint_text">#42FFFFFF</color>
    <color name="material_drawer_dark_divider">#1FFFFFFF</color>
    <!-- MaterialDrawer DEFAULT DARK drawer colors -->
    <color name="material_drawer_dark_selected">#202020</color>
    <color name="material_drawer_dark_selected_text">@color/material_drawer_primary</color>
    <color name="material_drawer_dark_header_selection_text">#FFF</color>

#FAQ ###How can i create a drawer without a default selection

//just use this with the Drawer
.withSelectedItem(-1)

###I have problems with the SoftKeyboard. How can i fix this? The MaterialDrawer will display your activity as FullScreen. Starting with API 19 the adjustResize works different then. This is default Android behavior. This is a big issue for a lot of devs so i've created a helper which "fixes" this issue. (It is recommend to just enable it for activities / fragments which need it)

.keyboardSupportEnabled(activity, enabled)

A additional workaround is to disable the translucent StatusBar (This will break the drawer to be displayed under the StatusBar). .withTranslucentStatusBar(false)

You can read about this here: mikepenz#95, mikepenz#183, mikepenz#196

###Can I lock the Drawer As the MaterialDrawer will just create a normal DrawerLayout (with some magic around it) everything a normal DrawerLayout can do is also available in the MaterialDrawer.

//get the DrawerLayout from the Drawer
DrawerLayout drawerLayout = result.getDrawerLayout();
//do whatever you want with the Drawer. Like locking it. 
drawerLayout.setDrawerLockMode(int lockMode); //or (int lockMode, int edgeGravity)

###Can I use my own DrawerLayout implementation MaterialDrawer allows you to use a compatible implementation of MaterialDrawer. Please note that the provided layout must follow the same structure as the MaterialDrawer internal one.

Start by copying the material_drawer.xml file inside your project, and replace android.support.v4.widget.DrawerLayout with the fully qualified name of your class (com.yourapp.com.ui.CustomDrawerLayout for example). Please note that your class must extend the original DrawerLayout.

You'll then be able to use this custom class:

builder.withDrawerLayout(R.layout.material_drawer);

#Apps using the MaterialDrawer (feel free to send me new projects)

• wall:splash
• GitSkarios
• Screener
• Academic Schedule
• Strength
• Sprit Club
• FitHub
• StickyNotes
• Smartphone Italia
• MLManager
• Hold'Em Poker Manager
• Fimpl
• +UEA
• PixCell8
• TS3 Viewer for TeamSpeak 3
• Teacher Gradebook
• Tabe3 News Reader
• Facepunch Droid
• World Tourist Attractions
• HipCar
• AS Sales Management
• Sporza Voetbal
• Atmosphere

#Articles about the MaterialDrawer

• java-help.ru

#Credits

• Mirosław Stanek - GitHub

  • For his InstaMaterial concept and the idea of inflating the drawerLayout InstaMaterial Concept

• Lunae Luman - Behance for the Header Image

#Developed By

• Mike Penz
• mikepenz.com - [email protected]
• paypal.me/mikepenz

#License

Copyright 2016 Mike Penz

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.