DrawerLayout

public class DrawerLayout
extends ViewGroup implements Openable

java.lang.Object
   ↳ android.view.View
     ↳ android.view.ViewGroup
       ↳ androidx.drawerlayout.widget.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.

Drawer positioning and layout is controlled using the android:layout_gravity attribute on child views corresponding to which side of the view you want the drawer to emerge from: left or right (or start/end on platform versions that support layout direction.) Note that you can only have one drawer view for each vertical edge of the window. If your layout configures more than one drawer view per vertical edge of the window, an exception will be thrown at runtime.

To use a DrawerLayout, position your primary content view as the first child with width and height of match_parent and no layout_gravity>. Add drawers as child views after the main content view and set the layout_gravity appropriately. Drawers commonly use match_parent for height with a fixed width.

DrawerLayout.DrawerListener can be used to monitor the state and motion of drawer views. Avoid performing expensive operations such as layout during animation as it can cause stuttering; try to perform expensive operations during the STATE_IDLE state. DrawerLayout.SimpleDrawerListener offers default/no-op implementations of each callback method.

As per the Android Design guide, any drawers positioned to the left/start should always contain content for navigating around the application, whereas any drawers positioned to the right/end should always contain actions to take on the current content. This preserves the same navigation left, actions right structure present in the Action Bar and elsewhere.

For more information about how to use DrawerLayout, read Creating a Navigation Drawer.

Summary

Nested classes

interface DrawerLayout.DrawerListener

Listener for monitoring events about drawers. 

class DrawerLayout.LayoutParams

 

class DrawerLayout.SavedState

State persisted across instances  

class DrawerLayout.SimpleDrawerListener

Stub/no-op implementations of all methods of DrawerLayout.DrawerListener

Constants

int LOCK_MODE_LOCKED_CLOSED

The drawer is locked closed.

int LOCK_MODE_LOCKED_OPEN

The drawer is locked open.

int LOCK_MODE_UNDEFINED

The drawer's lock state is reset to default.

int LOCK_MODE_UNLOCKED

The drawer is unlocked.

int STATE_DRAGGING

Indicates that a drawer is currently being dragged by the user.

int STATE_IDLE

Indicates that any drawers are in an idle, settled state.

int STATE_SETTLING

Indicates that a drawer is in the process of settling to a final position.

Inherited constants