This is an Example of React Native Navigation Drawer for Android and IOS. We will use react-navigation to make a navigation drawer in this example. React Native Navigation Drawer is a very popular component in app development. It provides you to manage the number of app options in a very easy manner. A user can navigate from one screen to another screen very easily by just pulling out the drawer. Here is an example of a navigation drawer.
Make React Native Navigation Drawer Using
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 | const DrawerNavigatorExample = createDrawerNavigator({ //Drawer Optons and indexing Screen1: { //Title screen: FirstActivity_StackNavigator, navigationOptions: { drawerLabel: "Demo Screen 1" } }, Screen2: {//Title screen: Screen2_StackNavigator, navigationOptions: { drawerLabel: "Demo Screen 2" } }, Screen3: {//Title screen: Screen3_StackNavigator, navigationOptions: { drawerLabel: "Demo Screen 3" } }, }); export default createAppContainer(DrawerNavigatorExample); |
In this example, we will make a navigation drawer with Three screens. So let’s get started.
To Make a React Native App
Getting started with React Native will help you to know more about the way you can make a React Native project. We are going to use react-native init to make our React Native App. Assuming that you have node installed, you can use npm to install the react-native-cli command line utility. Open the terminal and go to the workspace and run
npm install -g react-native-cliRun the following commands to create a new React Native project
react-native init ProjectNameIf you want to start a new project with a specific React Native version, you can use the --version argument:
react-native init ProjectName --version X.XX.Xreact-native init ProjectName --version react-native@nextThis will make a project structure with an index file named App.js in your project directory.
Installation of Dependencies
To use createDrawerNavigator, createStackNavigator you need to install react-navigation and react-native-gesture-handler dependencies.
To install these dependencies open the terminal and jump into your project
1 | cd ProjectName |
Run the following commands
1 | npm install react-navigation --save |
1 | npm install react-native-gesture-handler --save |
This command will copy all the dependencies into your node_module directory. –save is optional, it is just to update dependencies in your package.json file.
After installing the dependencies you need to link it with your project using
1 | react-native link |
After linking the dependency if you face Could not Compile Settings File project/android/settings.gradle error while building and installing the project then you can find the solution here.
Project Structure
To start with this Example you need to create a directory named pages in your project and create three files Screen1.js, Screen2.js, and Screen3.js in it.
To have the drawer Icon in Action Bar you have to make an image directory in your project and have to copy any drawer image with name drawer.png (For this example. You can change if you want but you need to change the file name in code too).
Here is the drawer.png if you want to download.
Now Open App.js in any code editor and replace the code with the following code.
App.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 | //This is an example code for NavigationDrawer// import React, { Component } from 'react'; //import react in our code. import { View, Image, TouchableOpacity } from 'react-native'; // import all basic components //For React Navigation 2.+ import following //import {DrawerNavigator, StackNavigator} from 'react-navigation'; //For React Navigation 3.+ import following import { createDrawerNavigator, createStackNavigator, createAppContainer, } from 'react-navigation'; import Screen1 from './pages/Screen1'; import Screen2 from './pages/Screen2'; import Screen3 from './pages/Screen3'; class NavigationDrawerStructure extends Component { //Structure for the navigatin Drawer toggleDrawer = () => { //Props to open/close the drawer this.props.navigationProps.toggleDrawer(); }; render() { return ( <View style={{ flexDirection: 'row' }}> <TouchableOpacity onPress={this.toggleDrawer.bind(this)}> {/*Donute Button Image */} <Image source={require('./image/drawer.png')} style={{ width: 25, height: 25, marginLeft: 5 }} /> </TouchableOpacity> </View> ); } } //For React Navigation 2.+ need to use StackNavigator instead createStackNavigator //const FirstActivity_StackNavigator = StackNavigator({ //For React Navigation 3.+ const FirstActivity_StackNavigator = createStackNavigator({ //All the screen from the Screen1 will be indexed here First: { screen: Screen1, navigationOptions: ({ navigation }) => ({ title: 'Demo Screen 1', headerLeft: <NavigationDrawerStructure navigationProps={navigation} />, headerStyle: { backgroundColor: '#FF9800', }, headerTintColor: '#fff', }), }, }); //For React Navigation 2.+ need to use StackNavigator instead createStackNavigator //const FirstActivity_StackNavigator = StackNavigator({ //For React Navigation 3.+ const Screen2_StackNavigator = createStackNavigator({ //All the screen from the Screen2 will be indexed here Second: { screen: Screen2, navigationOptions: ({ navigation }) => ({ title: 'Demo Screen 2', headerLeft: <NavigationDrawerStructure navigationProps={navigation} />, headerStyle: { backgroundColor: '#FF9800', }, headerTintColor: '#fff', }), }, }); //For React Navigation 2.+ need to use StackNavigator instead createStackNavigator //const FirstActivity_StackNavigator = StackNavigator({ //For React Navigation 3.+ const Screen3_StackNavigator = createStackNavigator({ //All the screen from the Screen3 will be indexed here Third: { screen: Screen3, navigationOptions: ({ navigation }) => ({ title: 'Demo Screen 3', headerLeft: <NavigationDrawerStructure navigationProps={navigation} />, headerStyle: { backgroundColor: '#FF9800', }, headerTintColor: '#fff', }), }, }); //For React Navigation 2.+ need to use DrawerNavigator instead createDrawerNavigator //const DrawerNavigatorExample = DrawerNavigator({ //For React Navigation 3.+ const DrawerNavigatorExample = createDrawerNavigator({ //Drawer Optons and indexing Screen1: { //Title screen: FirstActivity_StackNavigator, navigationOptions: { drawerLabel: 'Demo Screen 1', }, }, Screen2: { //Title screen: Screen2_StackNavigator, navigationOptions: { drawerLabel: 'Demo Screen 2', }, }, Screen3: { //Title screen: Screen3_StackNavigator, navigationOptions: { drawerLabel: 'Demo Screen 3', }, }, }); //For React Navigation 2.+ need to export App only //export default App; //For React Navigation 3.+ export default createAppContainer(DrawerNavigatorExample); |
Open pages/Screen1.js in any code editor and the Replace the code with the following code.
Screen1.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | //This is an example code for NavigationDrawer// import React, { Component } from 'react'; //import react in our code. import { StyleSheet, View, Text } from 'react-native'; // import all basic components export default class Screen1 extends Component { //Screen1 Component render() { return ( <View style={styles.MainContainer}> <Text style={{ fontSize: 23 }}> Screen 1 </Text> </View> ); } } const styles = StyleSheet.create({ MainContainer: { flex: 1, paddingTop: 20, alignItems: 'center', marginTop: 50, justifyContent: 'center', }, }); |
Open pages/Screen2.js in any code editor and the Replace the code with the following code.
Screen2.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | //This is an example code for NavigationDrawer// import React, { Component } from 'react'; //import react in our code. import { StyleSheet, View, Text } from 'react-native'; // import all basic components export default class Screen2 extends Component { //Screen2 Component render() { return ( <View style={styles.MainContainer}> <Text style={{ fontSize: 23 }}> Screen 2 </Text> </View> ); } } const styles = StyleSheet.create({ MainContainer: { flex: 1, paddingTop: 20, alignItems: 'center', marginTop: 50, justifyContent: 'center', }, }); |
Open pages/Screen3.js in any code editor and the Replace the code with the following code.
Screen3.js
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 | //This is an example code for NavigationDrawer// import React, { Component } from 'react'; //import react in our code. import { StyleSheet, View, Text } from 'react-native'; // import all basic components export default class Screen3 extends Component { //Screen3 Component render() { return ( <View style={styles.MainContainer}> <Text style={{ fontSize: 23 }}> Screen 3 </Text> </View> ); } } const styles = StyleSheet.create({ MainContainer: { flex: 1, paddingTop: 20, alignItems: 'center', marginTop: 50, justifyContent: 'center', }, }); |
To Run the React Native App
Open the terminal again and jump into your project using.cd ProjectNamereact-native run-androidreact-native run-ios (macOS only).IOS
ANDROID
That was the React Native Navigation Drawer. If you have any doubt or you want to share something about the topic you can comment below or contact us here. There will be more posts coming soon. Stay tuned!
Hope you liked it. 🙂
This code is not work in expo environment
React Navigation has updated to 3.+ please wait we will update it today only.
Did you update?
Did you update
Updated For React navigation 3.+.
Did you update?
Updated For React navigation 3.+.
Showing the error: undefined is not a function (evaluating ‘_this.props.navigationProps.toggleDrawer()’)
toggleDrawer
Can you please check this issue?
Hi Deepti,
Can you please check the react-navigation version as this issue is very old and generally comes while using react-navigation 2.0. This Example is updated for the react-navigation 3.+.
Thank you for your response.
It was some issue in my route configuration. Now working fine.
Do you have any article for showing the (Logo) image above the drawer navigation?
Hello Deepti,
Happy to see you soon.
You can visit 3 Ways to Add Image Icon Inside Navigation Bar in React Native (https://aboutreact.com/react-native-image-icon-inside-navigation-bar/)
And for the Icon inside the Navigation Bar in React Native
you can use the same navigation drawer(https://aboutreact.com/react-native-navigation-drawer/)
If you want to add anything or you want to modify navigation header you can modify NavigationDrawerStructure something like this
https://gm1.ggpht.com/f_9W2DQQyS4rxVw59LUGkgmRM8DG2s3jYRmG2IdJ5acoGwk18YyVttaDCxw5szaQCwol8zFX4uOO0HRRZymsT0CP4qqmEX33lXEU5Kq4nfdCKdJo92YU93pkXB9U94yE3daVaGiXuQLrW1RwDHRBlDX2ij-fOppw0ScfHM-8d3a_uuVVWXDG0JVejUTdOSRUkq7KU4kUt59TWRiGFktjPp2HCy2TpRQR0WcG4eXQKTq7JIj-sL0zxIBndtmQR8Zk7yu1LOKxVz8KMeNfWDSq0MsqpLeZr1050avxRLEnucPt3NaGfj7_i0MbB54m8iofbHC6VFQpjjyOt1NMfQu5h3mLSkf_zBhBxRIfJWiXrG0RsI12ZgcX5B4hcdsqHmBAVaLXbdmhtFjYtPELtA_IK33uwGtFoB5GVTXkANlPjlY2vS44MxS6AtpPTaLLqNGhbihJcO0cF-7g9PQcp27sAYeUJTnOvWsc_7HfBGyB_tp1TTTorFpVNG0vqwBCyXh5S0MLIZuziyBr3UcfIAd9896ugBRf70W5tdHavIIB7UwIgAmJAv0Ml1huVpcJwipsdW2CYHO6XQDwzwNr–HlRgmw8XIP35sww9O2tBCIVrmwEBSp0VYKOU3krwLm3rFom6IRGc35E2eNbpIaL-765RkUH0tCdp8YHjdnoIdSzDeFYwB7XKlbUebu4tda47FgNb5VXTtN7jTi2e768idMRGmTsH38vX4aNRcKMA=s0-l75-ft-l75-ft
class NavigationDrawerStructure extends Component {
//Structure for the navigatin Drawer
toggleDrawer = () => {
//Props to open/close the drawer
this.props.navigationProps.toggleDrawer();
};
render() {
return (
<View style={{ flexDirection: ‘row’ }}>
<TouchableOpacity onPress={this.toggleDrawer.bind(this)}>
{/*Donute Button Image */}
<Image
source={require(‘./image/drawer.png’)}
style={{ width: 25, height: 25, marginLeft: 5 }}
/>
</TouchableOpacity>
{/*You can put your images here or can customize anything from here*/}
<Image
source={{uri:’https://aboutreact.com/wp-content/uploads/2018/07/logosmalltransparen.png’,}}
style={{ width: 25, height: 25, marginLeft: 5 }}
/>
</View>
);
}
}
Deepti, I have the same problem. Can you share what the issue with your route configuration was?
I had to change to this.props.navigationProps.navigation.toggleDrawer() to make it work.
Hello Max,
Good to hear that it works for you. Can you please confirm the React Navigation version you are using? as I always use this.props.navigationProps.toggleDrawer(); and it is working properly. Why you are facing the issue?
I had a conversation with Dipti and she had the problem of configuration not with the toggle drawer.
Excellent example/tutorial. Thanks a lot.
Welcome 🙂
Thank you for your appreciation your words matter a lot.
I would like to pass a value from one class in a .js file to another class in another .js file.
You can see the following example and can use according to your need:
1. Passing a value from one screen to another using react navigation.
https://aboutreact.com/react-native-pass-value-from-one-screen-to-another-using-react-navigation/
2. Global Scope Variable which can be accessed from anywhere once created
https://aboutreact.com/react-native-global-scope-variables/
3. You can also call the function of another class
https://aboutreact.com/example-to-call-functions-of-other-class-from-current-class-in-react-native/
You can use any of the solutions according to your need.
This text is goods. It’s help me a lot. Thanks you.
Welcome 🙂
Thank you sooooooooooooooooooooooooo much you really help me alot
im subscribing right now im very happy
Thank you so much. Excellent and working properly.Thanks again.
Happy to help you 😊
undefined is not a function (evaluating ‘(0, _reactNavigation.createStackNavigator)’)
react 3
Hello nilesh,
Can you please cross check the react navigation version and have you linked the project correctly??
Hi, can I hide a screen from the drawer?
Here is the example https://aboutreact.com/how-to-hide-navigation-drawer-sidebar-option/
Hello, I have this issues when trying to pass params to another screen, e.g. passing email from users list to user detail screen….
TypeError: TypeError: undefined is not an object (evaluating ‘this.props.navigation.state.params.JSON_ListView_Clicked_Item’)
Have you properly seen the example?
This error comes when you are not passing any value from 1st screen and try to get the value in the 2nd one..
Actually I am. on the users list screen I have…..
this.props.navigation.navigate(‘Profiles’, { Emailsss: item.email })} > {item.first_name} {item.last_name}
and I get this error…
TypeError: TypeError: undefined is not an object (evaluating ‘this.props.navigation.state.params.Emailsss’)
I had to change from JSON_ListView_Clicked_Item to Emailsss to try fixing, but still not working.
It Started happening since I implemented Drawer navigation.
Actually I am. on the users list screen I have…..
this.props.navigation.navigate(‘Profiles’, { Emailsss: item.email })} > {item.first_name} {item.last_name}
and I get this error…
TypeError: TypeError: undefined is not an object (evaluating ‘this.props.navigation.state.params.Emailsss’)
I had to change from JSON_ListView_Clicked_Item to Emailsss to try fixing, but still not working.
It Started happening since I implemented Drawer navigation.
Hello Ayodele,
Can you please share your code on hello@aboutreact.com or aboutreact11@gmail.com so that I can see it.
How can i remove the header from inside pages like
Screen1 List -> Screen Details is page where i need back button how i can achieve this also change the header title.
You can follow this example https://aboutreact.com/switch-screen-out-of-the-navigation-drawer-in-react-native/
showing blank white screen
Can you please share the code and the screenshot on aboutreact11@gmail.com?
showing some blank white screen
Can you please share the code and the screenshot on aboutreact11@gmail.com?
I already update react native navigation into 3+ but i also get error : undefined is not and object : this.props.navigationProps.toggleDrawer. please help
Can you please check whether the installation of the library didn’t give you any error and linking of the library was fine.
How to access drawer in swipe gestures??
It is already there. Just swipe left to right and you will see the drawer coming out.
null is not an object ( evaluating ‘RNGestureHandlerModule.Direction’)
My app:
“dependencies”: {
“react”: “16.8.6”,
“react-native”: “0.60.3”,
“react-native-gesture-handler”: “^1.3.0”,
“react-navigation”: “^3.11.1”
}
Have you liked the library? This often comes when you install the library but haven’t installed it properly.
By default there is a back arrow above the navigation header. How to disable it?
While working with Navigator it shows the back arrow on the screen automatically if any of the previous screen is in the stack. So there are two solutions for that.
1. Hide the default header https://aboutreact.com/react-native-hide-navigation-bar-and-make-screen-full-screen/
and make your own custom header https://aboutreact.com/custom-header-using-navigation-options-in-react-native/
2. If you don’t want to go to the previous screen as we do in case of Splash/Introduction screen then instead of Stack Navigator you can use Switch Navigator https://aboutreact.com/react-native-finish-current-screen-while-navigating-to-next-screen/
Hi, very nice and clear.
Do you guys have an account where we can clone the code from? a github repo?
Thanks!
Hi Rod,
Not yet as React Native versions are changing very frequently almost in a month so we think the code base will expire over a time but still We are planning for that with some solution of this frequent changes.
Thanks a lot, I was struggling to make it work. I was not sure if I had linked rn gesture handler correctly, but apparently I did. Just my code was not working but yours does so thanks a lot!
It is nice to hear that. 🙂
Can you please share what is the problem you are facing in your code? Maybe I can help you.
Thanks a lot excellent tutorial.I have a small doubt in my example i have created a custom drawer menu where top area will be occupied by main app icon and below will my drawer menu like home,about,settings… etc so my question is on press of the main icon i want to close the drawer menu and update the state of the home screen.
To close the drawer menu you can use this.props.navigationProps.toggleDrawer(); and for the 2nd point you can take the reference from Custom Navigation Drawer / Sidebar with Image and Icon in Menu Options
Hello Snehal,
Thank you for the snippet.
I tried to add multple indexes in a stackNavigator but there wasn’t any changes.
Could you explain the utility to do that (if there is) and what should be the result.
Hello Sevag, If you talk about the stack navigator then they are related to the single screen. In a single line, drawer navigation contains multiple stack navigator where each index of drawer navigator is a sidebar option and each index of the stack navigator is the multiple screens in the single option.
If we have option1 with screen11, screen12, screen13, option2 with screen21, screen22, and option3 with screen31 then option1, option2, and option3 will be the drawer options and will come in drawer navigator but in the form of stack navigator with the same screen in a single option.
how can i add a logo or image background inside the drawer?
For this please follow Custom Navigation Drawer / Sidebar with Image and Icon in Menu Options
Thanks alot Sir, great job done please share more example for the beginners… must appreciated…
Thank you for appreciation 🙂