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. 4+. 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.

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

If 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.X
react-native init ProjectName --version react-native@next

This will make a project structure with an index file named App.js in your project directory.

Installation of Dependencies

This example is updated for the React Navigation 4.0+. For more about React Navigation 4 please have a look at Using React Navigation 4.0 in React Native apps.

To install the dependencies open the terminal and jump into your project

1. Install react-navigation dependency to import createAppContainer

2. Install react-native-gesture-handler dependency to support gesture navigation

3. Install react-navigation-drawer to import createDrawerNavigator

4. Install react-native-reanimated for the drawer animation (Used internally by react-navigation-drawer)

5. For the Icons, install react-native-elements

These steps are enough for the drawer navigation but in this example we are also using createStackNavigator to switch screeens, so please follow the next step also

6. Install react-navigation-stack to import createStackNavigator

These commands will copy all the dependencies into your node_module directory.

Linking of Dependency

After the updation of React Native 0.60, they have introduced autolinking feature means we do not require to link the library but they have also mentioned that some libraries need linking and react-native-vector-icons is one of those cases. So for that we need to link the library using

CocoaPods Installation

In this example we need to install the pods for react-native-gesture-handler, react-native-vector-icons and react-native-reanimated.

Please use the following command to install CocoaPods

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. 4+. 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. 🙂

11 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.

  1. Hi,
    It is react native version so please give me suitable example. And above example is not working at my end. It is showing error of CustomSidebarMenu.js targetModule Name react-native elements message Unable to resolve.
    react-native-cli: 2.0.1
    react-native: 0.60.3
    Thanks

    • Hmm, it looks like you have updated the latest React native Version. These examples are completely running on React native 0.59. Maybe some changes in the latest one. Please wait I’ll see and will update it soon.

  2. Thanks for this amazing article. It helped me a lot. One thing though, how can we add logout button with required functionality rather than navigating to screen, Thanks in advance

  3. hello mr snehal, there’s a problem with ur snack “unable to resolve module ‘module ://@babel/runtime/helper/interopRequireWildcard.js’

    please check it again,thanks

Leave a Comment

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