DrawerLayoutAndroid

React component that wraps the platform DrawerLayout (Android only). The Drawer (typically used for navigation) is rendered with renderNavigationView and direct children are the main view (where your content goes). The navigation view is initially not visible on the screen, but can be pulled in from the side of the window specified by the drawerPosition prop and its width can be set by the drawerWidth prop.

Example

import React, {useRef, useState} from 'react';
import {Button, DrawerLayoutAndroid, Text, StyleSheet} from 'react-native';
import {SafeAreaView, SafeAreaProvider} from 'react-native-safe-area-context';

const App = () => {
  const drawer = useRef(null);
  const [drawerPosition, setDrawerPosition] = useState('left');
  const changeDrawerPosition = () => {
    if (drawerPosition === 'left') {
      setDrawerPosition('right');
    } else {
      setDrawerPosition('left');
    }
  };

  const navigationView = () => (
    <SafeAreaView style={[styles.container, styles.navigationContainer]}>
      <Text style={styles.paragraph}>I'm in the Drawer!</Text>
      <Button
        title="Close drawer"
        onPress={() => drawer.current.closeDrawer()}
      />
    </SafeAreaView>
  );

  return (
    <SafeAreaProvider>
      <DrawerLayoutAndroid
        ref={drawer}
        drawerWidth={300}
        drawerPosition={drawerPosition}
        renderNavigationView={navigationView}>
        <SafeAreaView style={styles.container}>
          <Text style={styles.paragraph}>Drawer on the {drawerPosition}!</Text>
          <Button
            title="Change Drawer Position"
            onPress={() => changeDrawerPosition()}
          />
          <Button
            title="Open drawer"
            onPress={() => drawer.current.openDrawer()}
          />
        </SafeAreaView>
      </DrawerLayoutAndroid>
    </SafeAreaProvider>
  );
};

const styles = StyleSheet.create({
  container: {
    flex: 1,
    paddingHorizontal: 16,
  },
  navigationContainer: {
    backgroundColor: '#ecf0f1',
  },
  paragraph: {
    padding: 16,
    fontSize: 15,
    textAlign: 'center',
  },
});

export default App;

Reference

Props

View Props

Inherits View Props.

drawerBackgroundColor

Specifies the background color of the drawer. The default value is white.

drawerLockMode

Specifies the lock mode of the drawer. The drawer can be locked in 3 states:

• unlocked (default), meaning that the drawer will respond (open/close) to touch gestures.
• locked-closed, meaning that the drawer will stay closed and not respond to gestures.
• locked-open, meaning that the drawer will stay opened and not respond to gestures.

drawerPosition

Specifies the side of the screen from which the drawer will slide in. By default it is set to left.

drawerWidth

Specifies the width of the drawer, more precisely the width of the view that be pulled in from the edge of the window.

keyboardDismissMode

Determines whether the keyboard gets dismissed in response to a drag.

onDrawerClose

Function called whenever the navigation view has been closed.

onDrawerOpen

Function called whenever the navigation view has been opened.

onDrawerSlide

Function called whenever there is an interaction with the navigation view.

onDrawerStateChanged

Function called when the drawer state has changed. The drawer can be in 3 states: idle, dragging, settling.

renderNavigationView

The navigation view that will be rendered to the side of the screen and can be pulled in.

statusBarBackgroundColor

Make the drawer take the entire screen and draw the background of the status bar to allow it to open over the status bar. It will only have an effect on API 21+.

Methods

closeDrawer()

closeDrawer();

Closes the drawer.

openDrawer()

openDrawer();

Opens the drawer.

Last updated: Jul 07, 2026