React Navigation Header Customization in RN using Navigation Options
This is an example of React Navigation Header Customization in React Native using Navigation Options. In this example, we will see how to customize the Navigation Bar/ Navigation header. React Native does not provide any header by default, it comes when we add React Navigation to switch the activity.
Sometimes we have to customize the header according to the needs and we can easily do it with the help of navigation options. In this post, we will see the full customized header and customization of right and left header.
Complete Header customization using
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 | static navigationOptions = ({ navigation }) => { //return header with Custom View which will replace the original header return { header: ( <View style={{ height: 45, marginTop: 20, backgroundColor: 'red', justifyContent: 'center', }}> <Text style={{ color: 'white', textAlign: 'center', fontWeight: 'bold', fontSize: 18, }}> This is Custom Header </Text> </View> ), }; }; |
Left and Right header customization using
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 | static navigationOptions = ({ navigation }) => { return { //Heading/title of the header title: navigation.getParam('Title', 'Left Right Custom Header'), //Heading style headerStyle: { backgroundColor: navigation.getParam('BackgroundColor', 'red'), }, //Heading text color headerTintColor: navigation.getParam('HeaderTintColor', '#fff'), headerRight: ( <TouchableOpacity onPress={() => alert('Right Menu Clicked')}> <Text style={{ color: 'white', }}> Right Menu </Text> </TouchableOpacity> ), headerLeft: ( <TouchableOpacity onPress={() => navigation.navigate('FirstPage')}> <Text style={{ color: 'white', }}> Left Menu </Text> </TouchableOpacity> ), }; }; |
In this example, We will create two screens and we will switch between them using React Navigation. On the first screen, you will see the full customized header and on the second screen, you will see the left and right header customization.
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.
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 thereact-native-cli command line utility.
Open the terminal and go to the workspace and runnpm install -g react-native-clireact-native init ProjectNameInstallation of Dependencies
To switch between the screens and to make a default navigation header you need to install react-navigation and react-native-gesture-handler dependencies.
To install these dependencies open the terminal and jump into your project using
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 will find the solution here.
Project Structure
To start with this Example you need to create a directory named pages in your project and create two files FirstPge.js and SecondPage.js
Now Open App.js in any code editor and replace the code with the following code.
react-navigation 3.+ have some changes as compared to react-navigation 2.+ so please go through the following lines. In this example, we are using “react-navigation”: “3.1.2”.
In Version 2+ you just need to export the default class.
1 | export default App; |
But In Version 3+ you have to wrap it with the createAppContainer and then you have to export it.
1 | export default createAppContainer(App); |
For this, you have to import createAppContainer from ‘react-navigation’. Have a look at the updated 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 | //This is an example code for the Custom Header// import React, { Component } from 'react'; //import react in our code. //For react-navigation 2.0+ import createStackNavigator only //import {createStackNavigator,} from 'react-navigation'; //For react-navigation 3.0+ import createStackNavigator and createAppContainer import {createStackNavigator,createAppContainer} from 'react-navigation'; import FirstPage from './pages/FirstPage'; import SecondPage from './pages/SecondPage'; //import all the screens we are going to switch const App = createStackNavigator({ FirstPage: { screen: FirstPage }, SecondPage: { screen: SecondPage }, }, { initialRouteName: 'FirstPage', } ); //For react-navigation 2.0+ export default class App direct //export default App; //For react-navigation 3.0+ change it to following export default createAppContainer(App); |
Open FirstPage.js in any code editor and replace the code with the following code.
FirstPage.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 | //This is an example code for the Custom Header// import React, { Component } from 'react'; //import react in our code import { View, Text, Button } from 'react-native'; //import all the components we are going to use. class FirstPage extends Component { //Navigation option to create menu in header static navigationOptions = ({ navigation }) => { //return header with Custom View which will replace the original header return { header: ( <View style={{ height: 45, marginTop: 20, backgroundColor: 'red', justifyContent: 'center', }}> <Text style={{ color: 'white', textAlign: 'center', fontWeight: 'bold', fontSize: 18, }}> This is Custom Header </Text> </View> ), }; }; render() { const { navigate } = this.props.navigation; return ( <View style={{ flex: 1, backgroundColor: '#ffdffd' }}> <View style={{ alignItems: 'center', flex: 1, justifyContent: 'center' }}> <Text style={{ fontSize: 20, fontWeight: 'bold', textAlign: 'center', }}> This is an example of custom header </Text> <Button title="Click to see left right align header" onPress={() => { this.props.navigation.navigate('SecondPage'); }} /> </View> </View> ); } } export default FirstPage; |
Open SecondPage.js in any code editor and replace the code with the following code.
SecondPage.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 | //This is an example code for the Custom Header// import React, { Component } from 'react'; //import react in our code. import { StyleSheet, View, Text, TouchableOpacity } from 'react-native'; //import all the components we are going to use. export default class SecondPage extends Component { //Navigation option to create menu in header static navigationOptions = ({ navigation }) => { return { //Heading/title of the header title: navigation.getParam('Title', 'Left Right Custom Header'), //Heading style headerStyle: { backgroundColor: navigation.getParam('BackgroundColor', 'red'), }, //Heading text color headerTintColor: navigation.getParam('HeaderTintColor', '#fff'), headerRight: ( <TouchableOpacity onPress={() => alert('Right Menu Clicked')}> <Text style={{ color: 'white', }}> Right Menu </Text> </TouchableOpacity> ), headerLeft: ( <TouchableOpacity onPress={() => navigation.navigate('FirstPage')}> <Text style={{ color: 'white', }}> Left Menu </Text> </TouchableOpacity> ), }; }; render() { const { navigate } = this.props.navigation; return ( <View style={styles.container}> <Text>Left and Right Custom menu options</Text> </View> ); } } const styles = StyleSheet.create({ container: { flex: 1, backgroundColor: '#fff', margin: 50, alignItems: 'center', 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).
This is how you can Customize Header using Navigation Options in React Native. 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:
We are sorry that this post was not useful for you!
Let us improve this post!
Thanks for your feedback!
Leave a Reply
Want to join the discussion? Feel free to contribute!