Custom Navigation Drawer / Sidebar with Image and Icon in Menu Options

Custom Navigation Drawer / Sidebar with Image and Icon in Menu Options

This is an example of Custom Navigation Drawer / Sidebar with Image and Icon in Menu Options with React Navigation V. 3+. We will use react-navigation to make a navigation drawer in this example. I hope you have already seen our last post on React Native Navigation Drawer as this post is the extended version of React Native Navigation Drawer.

In this example, we have a navigation drawer with 3 screens in the navigation menu. We will make the custom sidebar in place of the simple navigation drawer so that we can modify the Navigation Drawer menu options according to our need.

In the custom Sidebar, we will have a profile image and an array of option name with the icon and there targeted navigation screen. With the help of a loop and this array, we will make N number of options with icon in the Navigation Drawer.

This example will work for the React Navigation Version 3+. If you are using Version 2+ then please find the comments in the code for the suitable changes or can see our old post React Native Navigation Version 2+ for the help.

We are going to use contentComponent prop of createDrawerNavigator to set our custom view which is CustomSidebarMenu.js in this example.

To set the custom view in Navigation Drawer / Sidebar Menu

You can set your own custom sidebar too. So let’s get started with the example.

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-cli
Run the following commands to create a new React Native project
react-native init ProjectName
This 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

Run the following commands to install React Navigation Dependencies

For the Icons, we are using react-native-elements library so to install this dependency run

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

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.

Icons for the Sidebar

As I said in this example, we have used react-native-elements library which provides a different range of icons which are very useful. You can find more Icons from 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, Screen3.js in it for the Drawer navigation.

To have the drawer Icon in Action Bar / Header 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).

For the custom sidebar, make a file called CustomSidebarMenu.js in the project directory (not in the pages directory)

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

Open pages/Screen1.js in any code editor and the Replace the code with the following code.

Screen1.js

Open pages/Screen2.js in any code editor and the Replace the code with the following code.

Screen2.js

Open pages/Screen3.js in any code editor and the Replace the code with the following code.

Screen3.js

Open CustomSidebarMenu.js in any code editor and the Replace the code with the following code.

CustomSidebarMenu.js

(Custom Menu with large profile Image and Options with options)

To Run the React Native App

Open the terminal again and jump into your project using.
cd ProjectName
To run the project on an Android Virtual Device or on real debugging device
react-native run-android
or on the iOS Simulator by running
react-native run-ios (macOS only).

Android

 

IOS

This is how you can make a Custom Navigation Drawer / Sidebar with Image and Icon in Menu Options with React Navigation V. 3+. 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. 🙂

How useful was this post?

Click on a star to rate us!

Average rating / 5. Vote count:

As you found this post useful...

Follow us on social media!

We are sorry that this post was not useful for you!

Let us improve this post!

2 thoughts on “Custom Navigation Drawer / Sidebar with Image and Icon in Menu Options”

    • Hello Prashant, Example has been updated for the same please check the updated example. The additional thing is the definition of a global variable to manage the index of the current screen and while clicking on the option from the custom sidebar I am updating the index and on the basis of that changing the background and font color of the selected option.

Leave a Comment

This site uses Akismet to reduce spam. Learn how your comment data is processed.

You have successfully subscribed to the newsletter

There was an error while trying to send your request. Please try again.

About React will use the information you provide on this form to be in touch with you and to provide updates and marketing.