Dynamically Change React Navigation Value – Update navigationOptions

Update navigationOptions in React Navigation

This is an Example to Dynamically Change React Navigation Value – Update navigationOptions. You will see how to change the Navigation Option values dynamically from the click of a button or using a state. This can be easily done by setting the navigation params.

This example will be helpful if you want to change the navigation options like navigation text, navigation text color, background color, etc on a click of a button or on some certain condition. For example, if you are planning to make an application in which the user can change the theme of the application. Here is an example for you to Dynamically Change React Navigation Value.

To Dynamically Change navigationOptions Value

We can change the navigation bar title, background color and text color from the click of any button by setting the navigation options.

// To change navigation options
navigation.setOptions({
  title: 'Yellow Header',
  headerStyle: {
    backgroundColor: 'yellow', //Set Header color
  },
  headerTintColor: 'black', //Set Header text color
  headerTitleStyle: {
    fontWeight: 'bold', //Set Header text style
  },
});

In this example, we will use react-navigation to make the navigation bar on the top of the screen and then with the help of three different buttons we will change the color of the navigation bar. 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 command line interface to make our React Native App.

If you have previously installed a global react-native-cli package, please remove it as it may cause unexpected issues:

npm uninstall -g react-native-cli @react-native-community/cli

Run the following commands to create a new React Native project

npx react-native init ProjectName

If you want to start a new project with a specific React Native version, you can use the --version argument:

npx react-native init ProjectName --version X.XX.X

Note If the above command is failing, you may have old version of react-native or react-native-cli installed globally on your pc. Try uninstalling the cli and run the cli using npx.

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

Installation of Dependencies

For navigation we need to add react-navigation and other supporting dependencies.

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

cd ProjectName

1. Install react-navigation

npm install @react-navigation/native --save

2. Other supporting libraries react-native-screens and react-native-safe-area-context

npm install react-native-screens react-native-safe-area-context --save

react-native-screens package requires one additional configuration step to properly work on Android devices. Edit MainActivity.java file which is located in android/app/src/main/java/<your package name>/MainActivity.java.

Add the following code to the body of MainActivity class:

@Override
protected void onCreate(Bundle savedInstanceState) {
  super.onCreate(null);
}

and make sure to add the following import statement at the top of this file below your package statement:

import android.os.Bundle;

This change is required to avoid crashes related to View state being not persisted consistently across Activity restarts.

3. For the Stack Navigator install

npm install @react-navigation/native-stack --save

CocoaPods Installation

Please use the following command to install CocoaPods

npx pod-install

Project File Structure

To start with this example you need to create a directory named pages in your project and create a file HomeActivity.js in it.

Code

Now open App.js in any code editor and replace the code with the following code

App.js

// Dynamically Change React Navigation Value – Update navigationOptions
// https://aboutreact.com/dynamically-change-navigationoptions-value/

import React from 'react';

import {NavigationContainer} from '@react-navigation/native';
import {createNativeStackNavigator} from '@react-navigation/native-stack';

import HomeActivity from './pages/HomeActivity';

const Stack = createNativeStackNavigator();

const App = () => {
  return (
    <NavigationContainer>
      <Stack.Navigator initialRouteName="HomeActivity">
        <Stack.Screen
          name="HomeActivity"
          component={HomeActivity}
        />
      </Stack.Navigator>
    </NavigationContainer>
  );
};

export default App;

Open pages/HomeActivity.js in any code editor and replace the code with the following code

HomeActivity.js

// Dynamically Change React Navigation Value – Update navigationOptions
// https://aboutreact.com/dynamically-change-navigationoptions-value/

import React from 'react';
import {
  SafeAreaView,
  StyleSheet,
  Text,
  TouchableOpacity,
  View,
} from 'react-native';

const HomeActivity = ({navigation, route}) => {
  const changeHeaderYellow = () => {
    // Function to change navigation options
    navigation.setOptions({
      title: 'Yellow Header',
      headerStyle: {
        backgroundColor: 'yellow', //Set Header color
      },
      headerTintColor: 'black', //Set Header text color
      headerTitleStyle: {
        fontWeight: 'bold', //Set Header text style
      },
    });
  };

  const changeHeaderPink = () => {
    // Function to change navigation options
    navigation.setOptions({
      title: 'Pink Header',
      headerStyle: {
        backgroundColor: 'pink', //Set Header color
      },
      headerTintColor: 'black', //Set Header text color
      headerTitleStyle: {
        fontWeight: 'bold', //Set Header text style
      },
    });
  };

  const changeHeaderOrange = () => {
    // Function to change navigation options
    navigation.setOptions({
      title: 'Orange Header',
      headerStyle: {
        backgroundColor: 'orange', //Set Header color
      },
      headerTintColor: 'black', //Set Header text color
      headerTitleStyle: {
        fontWeight: 'bold', //Set Header text style
      },
    });
  };

  return (
    <SafeAreaView style={{flex: 1, backgroundColor: 'white'}}>
      <View style={styles.container}>
        <Text style={styles.header}>
          Dynamically Change React Navigation Value
          {'\n'}
          Update navigation Options
        </Text>

        {/* Change header color to yellow */}
        <TouchableOpacity
          onPress={changeHeaderYellow}
          activeOpacity={0.7}
          style={styles.buttonStyle}>
          <Text style={styles.textStyle}>APPLY YELLOW COLOR</Text>
        </TouchableOpacity>

        {/* Change header color to pink */}
        <TouchableOpacity
          onPress={changeHeaderPink}
          activeOpacity={0.7}
          style={styles.buttonStyle}>
          <Text style={styles.textStyle}>APPLY PINK COLOR</Text>
        </TouchableOpacity>

        {/* Change header color to orange */}
        <TouchableOpacity
          onPress={changeHeaderOrange}
          activeOpacity={0.7}
          style={styles.buttonStyle}>
          <Text style={styles.textStyle}>APPLY ORANGE COLOR</Text>
        </TouchableOpacity>
      </View>
      <Text style={{textAlign: 'center', color: 'grey'}}>
        www.aboutreact.com
      </Text>
    </SafeAreaView>
  );
};

export default HomeActivity;

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    alignItems: 'center',
    padding: 16,
  },
  header: {
    fontSize: 25,
    textAlign: 'center',
    marginVertical: 16,
  },
  buttonStyle: {
    width: '100%',
    height: 40,
    padding: 10,
    backgroundColor: '#808080',
    borderRadius: 2,
    marginTop: 12,
  },
  textStyle: {
    color: '#fff',
    textAlign: 'center',
  },
});

To Run the React Native App

Open the terminal again and jump into your project using.

cd ProjectName

1. Start Metro Bundler

First, you will need to start Metro, the JavaScript bundler that ships with React Native. To start Metro bundler run following command:

npx react-native start

Once you start Metro Bundler it will run forever on your terminal until you close it. Let Metro Bundler run in its own terminal. Open a new terminal and run the application.

2. Start React Native Application

To run the project on an Android Virtual Device or on real debugging device:

npx react-native run-android

or on the iOS Simulator by running (macOS only)

npx react-native run-ios

Output Screenshots

Output in Online Emulator

This is how you can change navigation options. If you have any doubts 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. 🙂

Leave a Comment

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