DrawerActions reference
DrawerActions
is an object containing methods for generating actions specific to drawer-based navigators. Its methods expand upon the actions available in CommonActions.
The following actions are supported:
openDrawer
The openDrawer
action can be used to open the drawer pane.
import { DrawerActions } from '@react-navigation/native';
navigation.dispatch(DrawerActions.openDrawer());
closeDrawer
The closeDrawer
action can be used to close the drawer pane.
import { DrawerActions } from '@react-navigation/native';
navigation.dispatch(DrawerActions.closeDrawer());
toggleDrawer
The toggleDrawer
action can be used to open the drawer pane if closed, or close if open.
import { DrawerActions } from '@react-navigation/native';
navigation.dispatch(DrawerActions.toggleDrawer());
jumpTo
The jumpTo
action can be used to jump to an existing route in the drawer navigator.
name
- string - Name of the route to jump to.params
- object - Screen params to pass to the destination route.
import { DrawerActions } from '@react-navigation/native';
const jumpToAction = DrawerActions.jumpTo('Profile', { name: 'Satya' });
navigation.dispatch(jumpToAction);