Example of Tooltip in React Native for Android and IOS

Tooltip

This is an example of Tooltip in React Native for Android and IOS using react-native-walkthrough-tooltip library. The Tooltip is a common graphical user interface element. It is used to show the usability of any button or any option.

In this example, we will see how to show a tooltip on a click of a button. So let’s get started.

Import Tooltip using

import Tooltip from 'react-native-walkthrough-tooltip';

How to Show Tooltip?

<Tooltip
  animated={true}
  // (Optional) When true, tooltip will animate
  // in/out when showing/hiding
  arrowSize={{ width: 16, height: 8 }}
  // (Optional) Dimensions of arrow bubble pointing to
  // the highlighted element
  backgroundColor="rgba(0,0,0,0.5)"
  // (Optional) Color of the fullscreen background
  isVisible={this.state.toolTipVisible}
  //(Must) When true, tooltip is displayed
  content={<Text>Hello! AboutReact</Text>}
  //(Must) This is the view displayed in the tooltip
  placement="bottom"
  //(Must) top, bottom, left, right, auto.
  onClose={() => setToolTipVisible(false)}
  //(Optional) Callback fired when the user taps the tooltip
>
  <TouchableHighlight
    style={styles.touchable}
    onPress={() => setToolTipVisible(true)}>
    <Text style={styles.touchableText}>
       Say Hi to AboutReact
    </Text>
  </TouchableHighlight>
</Tooltip>

For this example, we will make a screen with one button using TouchableHighlight and on the click of the button, we will change the visibility state of Tooltip to make it visible.

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 Dependency

To use Tooltip we need to install react-native-walkthrough-tooltip dependency.

To install this open the terminal and jump into your project using

cd ProjectName

Run the following command to install

npm install react-native-walkthrough-tooltip --save

This command will copy all the dependencies into your node_module directory. –save is optional, it is just to update the react-native-walkthrough-tooltip dependency in your package.json file.

Code

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

App.js

// Example of Tooltip in React Native for Android and IOS
// https://aboutreact.com/example-of-tooltip-in-react-native-for-android-and-ios/

// import React in our code
import React, {useState} from 'react';

// import all the components we are going to use
import {
  SafeAreaView,
  View,
  Text,
  StyleSheet,
  TouchableHighlight,
} from 'react-native';

//Import Tooltip
import Tooltip from 'react-native-walkthrough-tooltip';

const App = () => {
  const [toolTipVisible, setToolTipVisible] = useState(false);

  return (
    <SafeAreaView style={styles.container}>
      <View style={styles.container}>
        <Text style={styles.titleStyle}>
          Example of Tooltip in React Native for Android and IOS
        </Text>
        <Text style={styles.titleStyle}>www.aboutreact.com</Text>
        <Tooltip
          animated={true}
          // (Optional) When true,
          // tooltip will animate in/out when showing/hiding
          arrowSize={{width: 16, height: 8}}
          // (Optional) Dimensions of arrow bubble pointing
          // to the highlighted element
          backgroundColor="rgba(0,0,0,0.5)"
          // (Optional) Color of the fullscreen background
          // beneath the tooltip.
          isVisible={toolTipVisible}
          // (Must) When true, tooltip is displayed
          content={<Text>Hello! AboutReact</Text>}
          // (Must) This is the view displayed in the tooltip
          placement="bottom"
          // (Must) top, bottom, left, right, auto.
          onClose={() => setToolTipVisible(false)}
          // (Optional) Callback fired when the user taps the tooltip
        >
          <TouchableHighlight
            style={styles.buttonStyle}
            onPress={() => setToolTipVisible(true)}>
            <Text style={styles.buttonTextStyle}>
              Say Hi to AboutReact
            </Text>
          </TouchableHighlight>
        </Tooltip>
      </View>
    </SafeAreaView>
  );
};
export default App;

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    alignContent: 'center',
    textAlign: 'center',
    paddingTop: 30,
    backgroundColor: '#307ecc',
    padding: 16,
  },
  buttonStyle: {
    width: '100%',
    height: 40,
    padding: 10,
    backgroundColor: '#f5821f',
    marginTop: 30,
  },
  buttonTextStyle: {
    color: 'white',
    textAlign: 'center',
  },
  titleStyle: {
    color: 'white',
    textAlign: 'center',
    fontSize: 20,
    marginTop: 10,
  },
});

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 make a Tooltip in React Native for Android and IOS using react-native-walkthrough-tooltip. If you have any doubts or 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. 🙂