MaterialDrawer

Choose between MaterialDrawer and the standard Google Design Support Library drawer based on your required complexity:

Use Google's Support Library drawer if:

• You need a minimal drawer implementation.
• You only require standard Main items.
• You do not need profile functionality, custom items, custom styles, or advanced programmatic APIs.
• You prefer to keep the implementation as simple as possible for better user experience.

Use MaterialDrawer if you need advanced features such as:

• Profile Switcher: Functionality to switch between user profiles.
• Profile Page: A dedicated page for profile management.
• Custom Items: Support for different item sizes, checkboxes, and other specialized UI elements.
• High Customization: Extensive flexibility for custom styles and advanced programmatic control via the API.

The MaterialDrawerSliderView must be added as a child of a DrawerLayout. It acts as the slider content. Set its layout_gravity to start.

<androidx.drawerlayout.widget.DrawerLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:id="@+id/root"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    android:fitsSystemWindows="true">

    <!-- Your main content goes here -->
    ...

    <com.mikepenz.materialdrawer.widget.MaterialDrawerSliderView
        android:id="@+id/slider"
        android:layout_width="wrap_content"
        android:layout_height="match_parent"
        android:layout_gravity="start"
        android:fitsSystemWindows="true" />

</androidx.drawerlayout.widget.DrawerLayout>

MaterialDrawer does not include a built-in image loading library. To load images from URLs (e.g., for profile icons), you must initialize DrawerImageLoader with your preferred library (Picasso, Glide, etc.) before the first load occurs.

// Initialize with Picasso
DrawerImageLoader.init(object : AbstractDrawerImageLoader() {
    override fun set(imageView: ImageView, uri: Uri, placeholder: Drawable) {
        Picasso.get().load(uri).placeholder(placeholder).into(imageView)
    }

    override fun cancel(imageView: ImageView) {
        Picasso.get().cancelRequest(imageView)
    }
})

Since MaterialDrawer wraps a standard DrawerLayout, you can control its locking behavior using the setDrawerLockMode method. This allows you to prevent the drawer from being opened or closed via standard gestures or interactions.

drawerLayout.setDrawerLockMode(int lockMode); //or (int lockMode, int edgeGravity)

You can overwrite the global style for the BezelImageView used within the MaterialDrawer. This allows you to control the mask drawable, shadow drawing, press selectors, and scale types for the image views within the drawer.

<style name="BezelImageView">
    <item name="biv_maskDrawable">@drawable/material_drawer_rectangle_mask</item>
    <item name="biv_drawCircularShadow">false</item>
    <item name="biv_selectorOnPress">@color/material_drawer_primary</item>
    <item name="android:scaleType">centerInside</item>
</style>

When using an AccountHeader with only one profile, you can disable the profile selection dropdown and hide the arrow icon by setting selectionListEnabledForSingleProfile to false within the AccountHeader.Builder.

headerView.selectionListEnabledForSingleProfile = false

To open the MaterialDrawer during an Espresso instrumental test, you must use the DrawerActions.open() method. This requires the espresso-contrib library to be present in your project dependencies. You must target the drawer layout ID, which by default is R.id.material_drawer_layout.

// 1. Ensure espresso-contrib is in your androidTest dependencies
// androidTestCompile 'com.android.support.test.espresso:espresso-contrib:2.2.2'

// 2. Perform the open action using the default drawer layout ID
onView(withId(R.id.material_drawer_layout)).perform(DrawerActions.open());

To initialize a MaterialDrawer without any item being selected by default, set the selection position to -1 using setSelectionAtPosition(-1).

//just set the selection to -1
slider.setSelectionAtPosition(-1)

To apply the drawer's default styling, add materialDrawerStyle and materialDrawerHeaderStyle to your application theme.

Note: If you are using v9.x with Material 3, your Activity must use a Material3 theme as its base.

<style name="SampleApp.DayNight" parent="Theme.Material3.DayNight.NoActionBar">
    <item name="materialDrawerStyle">@style/Widget.MaterialDrawerStyle</item>
    <item name="materialDrawerHeaderStyle">@style/Widget.MaterialDrawerHeaderStyle</item>
</style>