Example to Use Ionicons in React Native using react-native-ionicons

Ionicons

This is an Example to Use Ionicons in React Native using react-native-ionicons. Ionicons are beautifully crafted open source icons built by the Ionic Framework team.

You can use Ionicons very anywhere easily. You can visit the official site of the Ionicons to find a variety of icons.

Use of Ionicons in React Native

To use the Ionicons in React Native you have to import react-native-ionicons dependency which will provide an Icon component. You can use this Icon component to create an Icon.
Prop “name” will render the same icon in Android and IOS.

<Icon name="information-circle-outline" />

But if you want to show the different icons for Android and IOS for the same Icon component then you can also use ios and android prop and can set the different icons.

<Icon ios="ios-add" android="md-add" />

Props

Name Type Default Description
name IconName Icon name used on all platforms
android IconName Icon name for Android devices
ios IconName Icon name for iOS devices
color ?string Icon color
size ?number 30 Icon size, namely fontSize

In this example, We will create a simple Screen with different icons and will run it in Android and IOS to see the changes. 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 Dependency

To use Icon component you need to install react-native-ionicons dependency.

To install this open the terminal and jump into your project

cd ProjectName

Run the following command

npm install react-native-ionicons --save

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

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-ionicons is one of those cases. So for that, we need to link the library using

react-native link react-native-ionicons

CocoaPods Installation

Now we need to install pods

cd ios && pod install && cd ..

Code

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

App.js

// Example to Use Ionicons in React Native using react-native-ionicons
// https://aboutreact.com/react-native-ionicons/

// Import React
import React from 'react';
// Import required components
import {SafeAreaView, StyleSheet, Text, View} from 'react-native';

//import Ionicons
import Icon from 'react-native-ionicons';

const App = () => {
  return (
    <SafeAreaView style={styles.container}>
      <View style={styles.container}>
        <Text style={styles.titleText}>
          Example to Use Ionicons in React Native
          using react-native-ionicons
        </Text>
        {/*Icon name used on all platforms*/}
        <Text style={styles.textStyle}>
          Icon (camera, information-circle-outline)
          for all platforms
        </Text>
        <Text style={styles.instructions}>
          <Icon name="camera" size={40} color="red" />
        </Text>
        <Icon
          name="information-circle-outline"
          size={40}
          color="blue"
        />
        {/*Different Icon for different platforms*/}
        <Text style={styles.textStyle}>
          Platform specific Icon
        </Text>
        <Icon
          ios="ios-add"
          android="md-albums"
          size={40}
          color="orange"
        />
        <Icon
          ios="ios-albums"
          android="md-add"
          size={40}
          color="green"
        />
      </View>
    </SafeAreaView>
  );
};
export default App;

const styles = StyleSheet.create({
  container: {
    flex: 1,
    justifyContent: 'center',
    alignItems: 'center',
    backgroundColor: 'white',
    padding: 10,
  },
  titleText: {
    fontSize: 20,
    fontWeight: 'bold',
    textAlign: 'center',
    paddingVertical: 20,
  },
  textStyle: {
    textAlign: 'center',
    marginTop: 20,
  },
  instructions: {
    textAlign: 'center',
    margin: 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

Download Source Code

Output Screenshots

IOS

react-native-ionicon-ios

Android

react-native-ionicon-android

That was the Example to Use Ionicons in React Native using react-native-ionicons. 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.