!Vector Icons for React Native

  

React Native Vector Icons

Elevate your React Native applications with the power of customizable vector icons. Ideal for embellishing buttons, logos, and navigation or tab bars, these icons seamlessly integrate into your projects. Their versatility makes extension and styling effortless.

For the integration of .svg files natively, you can explore react-native-vector-image.

Table of Contents

- Bundled Icon Sets
- Installation
- iOS Setup
- Android Setup
- macOS Setup
- Windows Setup
- Web Setup
- Upgrading
- Icon Component
- Icon.Button Component
- Usage as PNG Image/Source Object
- Multi-Style Fonts
- Custom Fonts
- Animation
- Usage Examples
- TabBar
- Generating Your Own Icon Set from a CSS File
- Changelog
- Troubleshooting
- License

Sponsorship

Should you find this library beneficial, kindly contemplate the option of sponsoring. Our envisioned endeavors encompass the restructuring of the repository into a monorepo architecture. This transition will empower independent versioning of icon sets, enhance performance, reduce bundle size, and simplify community contributions. Your sponsorship plays a pivotal role in materializing these advancements.

Bundled Icon Sets

Explore all icons.

- AntDesign from AntFinance (298 icons)
- Entypo by Daniel Bruce (v1.0.1 with 411 icons)
- EvilIcons designed by Alexander Madyankin & Roman Shamin (v1.10.1 with 70 icons)
- Feather created by Cole Bemis & Contributors (v4.28.0 featuring 286 icons)
- FontAwesome by Dave Gandy (v4.7.0 containing 675 icons)
- FontAwesome 5 from Fonticons, Inc. (v5.15.3 offering 1598 free and 7848 pro icons)
- FontAwesome 6 designed by Fonticons, Inc. (v6.1.2 featuring 2016 free and 16150 pro icons)
- Fontisto created by Kenan Gündoğan (v3.0.4 featuring 615 icons)
- Foundation by ZURB, Inc. (v3.0 with 283 icons)
- Ionicons crafted by Ionic (v7.1.0 containing 1338 icons)
- MaterialIcons by Google, Inc. (v4.0.0 featuring 2189 icons)
- MaterialCommunityIcons from MaterialDesignIcons.com (v6.5.95 including 6596 icons)
- Octicons designed by Github, Inc. (v16.3.1 with 250 icons)
- Zocial by Sam Collins (v1.4.0 with 100 icons)
- SimpleLineIcons crafted by Sabbir & Contributors (v2.5.5 with 189 icons)

Installation

1. Install the package via npm:
``sh
npm install --save react-native-vector-icons
`
2. Depending on the platform you're targeting (iOS/Android/Windows), follow the appropriate setup instructions.
3. If you're planning to use FontAwesome 5 or 6 icons, refer to these guides: FontAwesome 5 | FontAwesome 6

$3

- Navigate to node_modules/react-native-vector-icons and drag the Fonts folder (or select specific fonts) into your Xcode project.
- Make sure your app is checked under "Add to targets," and if adding the whole folder, check "Create groups."
- Not familiar with Xcode? Check out this article.

- Edit Info.plist and add a property called Fonts provided by application (or UIAppFonts if Xcode autocomplete is not working):
-

Above step might look something like this:

!XCode screenshot

- In Xcode, select your project in the navigator, choose your app's target, go to the Build Phases tab, and under Copy Bundle Resources, add the copied fonts.

- When using auto linking, it will automatically add all fonts to the Build Phases, Copy Pods Resources. Which will end up in your bundle.
To avoid that, create a react-native.config.js file at the root of your react-native project with:

`javascript
module.exports = {
dependencies: {
'react-native-vector-icons': {
platforms: {
ios: null,
},
},
},
};
`

_Note: Recompile your project after adding new fonts._

$3

#### Option: With Gradle (recommended)

To make font management smoother on Android, use this method:

- Edit android/app/build.gradle (NOT android/build.gradle) and add:

`gradle
apply from: file("../../node_modules/react-native-vector-icons/fonts.gradle")
`

To customize the fonts being copied, use:

`gradle
project.ext.vectoricons = [
iconFontNames: [ 'MaterialIcons.ttf', 'EvilIcons.ttf' ] // Specify font files
]

apply from: file("../../node_modules/react-native-vector-icons/fonts.gradle")

`

#### Option: Manual Integration

To manually integrate the library, follow these steps:

- Copy the contents from the Fonts folder and paste them into android/app/src/main/assets/fonts (ensure the folder name is lowercase, i.e., fonts).

#### Integrating Library for getImageSource Support

The following steps are optional and are only necessary if you intend to utilize the Icon.getImageSource function.

- Edit the android/settings.gradle file as shown below:

`diff
rootProject.name = 'MyApp'

include ':app'

+ include ':react-native-vector-icons'
+ project(':react-native-vector-icons').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-vector-icons/android')
`

- Edit the android/app/build.gradle (located in the app folder) as shown below:

`diff
apply plugin: 'com.android.application'

android {
...
}

dependencies {
implementation fileTree(dir: "libs", include: ["*.jar"])
//noinspection GradleDynamicVersion
implementation "com.facebook.react:react-native:+" // From node_modules

+ implementation project(':react-native-vector-icons')
}
`

- Edit your MainApplication.java (located deep within android/app/src/main/java/...) as shown below (note that there are two places to edit):

`diff
package com.myapp;

+ import com.oblador.vectoricons.VectorIconsPackage;

....

@Override
protected List getPackages() {
return Arrays.asList(
new MainReactPackage()
+ , new VectorIconsPackage()
);
}
`

Please note that this optional step is necessary only if your react-native app doesn't support auto-linking; otherwise, you can skip this.

$3

To set up the library on your macOS project using react-native-macos, follow these steps:

1. Browse to the node_modules/react-native-vector-icons folder and drag the Fonts folder into your project in Xcode. Ensure that your app is checked under "Add to targets," and select "Create folder references" when prompted.

2. Edit your Info.plist and include a new property named Application fonts resource path (or ATSApplicationFontsPath if Xcode's autocomplete isn't functioning or you're not using Xcode). Set the value of this property to Fonts.

_Please note that after adding new fonts, you need to recompile your project. Also, make sure that the Fonts folder is present under the Copy Bundle Resources section within the Build Phases of your Xcode project._

These steps will effectively integrate the vector icons library into your macOS project while utilizing the react-native-macos framework.

$3

To set up the library on your Windows project using react-native-windows, follow these steps:

1. In the top-level projects (/windows/project-name/Assets), copy and paste the font files.

2. Open your solution in Visual Studio:

a. Right-click the Assets folder in your solution.
b. Select Add > Existing Item.
c. Browse and select the fonts that you copied into /windows/project-name/assets.
d. Click Add.

_Please note that after adding new fonts, you need to recompile your project._

By following these steps, you'll seamlessly integrate the vector icons library into your Windows project, leveraging the react-native-windows framework.

$3

To integrate the library with your web project using webpack, follow these steps:

1. In your webpack configuration file, add a section to handle TTF files using url-loader or file-loader:

`js
{
test: /\.ttf$/,
loader: "url-loader", // or directly file-loader
include: path.resolve(__dirname, "node_modules/react-native-vector-icons"),
}
`

2. In your JavaScript entry point, consume the font files and inject the necessary style tag:

`js
// Use the prebuilt version of RNVI located in the dist folder
import Icon from 'react-native-vector-icons/dist/FontAwesome';

// Generate the required CSS
import iconFont from 'react-native-vector-icons/Fonts/FontAwesome.ttf';
const iconFontStyles = @font-face {
src: url(${iconFont});
font-family: FontAwesome;
};

// Create a stylesheet
const style = document.createElement('style');
style.type = 'text/css';

// Append the iconFontStyles to the stylesheet
if (style.styleSheet) {
style.styleSheet.cssText = iconFontStyles;
} else {
style.appendChild(document.createTextNode(iconFontStyles));
}

// Inject the stylesheet into the document head
document.head.appendChild(style);
`
By following these steps, you will seamlessly integrate the vector icons library into your web project using webpack, enabling you to effortlessly use the icons within your web application.

Upgrading

Upgrading this package often requires the font files linked to your projects to be updated as well. If the automatic linking works for you, running this again should update the fonts. Otherwise you need to follow the steps outlined in the installation section.

Icon Component

You can either use one of the bundled icons above or roll your own custom font.

`js
import Icon from 'react-native-vector-icons/FontAwesome';
const myIcon = ;
`

$3

Any Text property and the following:

| Prop | Description | Default |
| ----------- | ----------------------------------------------------------------------- | ----------- |
| size | Size of the icon, can also be passed as fontSize in the style object. | 12 |
| name | What icon to show, see Icon Explorer app or one of the links above. | _None_ |
| color | Color of the icon. | _Inherited_ |

$3

| Prop | Description |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| getFontFamily | Returns the font family that is currently used to retrieve icons as text. Usage: const fontFamily = Icon.getFontFamily() |
| getImageSource | Returns a promise that resolving to the source of a bitmap version of the icon for use with Image component et al. Usage: const source = await Icon.getImageSource(name, size, color) |
| getImageSourceSync | Same as getImageSource but synchronous. Usage: const source = Icon.getImageSourceSync(name, size, color) |
| getRawGlyphMap | Returns the raw glyph map of the icon set. Usage: const glyphMap = Icon.getRawGlyphMap() |
| hasIcon | Checks if the name is valid in current icon set. Usage: const isNameValid = Icon.hasIcon(name) |

$3

Since Icon builds on top of the Text component, most style properties will work as expected, you might find it useful to play around with these:

- backgroundColor
- borderWidth
- borderColor
- borderRadius
- padding
- margin
- color
- fontSize

NOTE: On android Text doesn't currently support border* styles, to circumvent this simply wrap your Icon with a View.

By combining some of these you can create for example :

!type
!star

Icon.Button Component

A convenience component for creating buttons with an icon on the left side.

`js
import Icon from 'react-native-vector-icons/FontAwesome';
const myButton = (
name="facebook"
backgroundColor="#3b5998"
onPress={this.loginWithFacebook}
>
Login with Facebook

);

const customTextButton = (


Login with Facebook


);
`

!buttons

$3

Any Text, TouchableHighlight or TouchableWithoutFeedback property in addition to these:

| Prop | Description | Default |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |
| color | Text and icon color, use iconStyle or nest a Text component if you need different colors. | white |
| size | Icon size. | 20 |
| iconStyle | Styles applied to the icon only, good for setting margins or a different color. _Note: use iconStyle for margins or expect unstable behaviour._ | {marginRight: 10} |
| backgroundColor | Background color of the button. | #007AFF |
| borderRadius | Border radius of the button, set to 0 to disable. | 5 |
| onPress | A function called when the button is pressed. | _None_ |

Usage as PNG Image/Source Object

Convenient way to plug this in into other components that rely on bitmap images rather than scalable vector icons. Takes the arguments name, size and color as described above.

`js
Icon.getImageSource('user', 20, 'red').then(source =>
this.setState({ userIcon: source })
);
`

Alternatively you may use the synchronous method Icon.getImageSourceSync to avoid rendering glitches. Keep in mind that this method is blocking and might incur performance penalties. Subsequent calls will use cache however.

Multi-Style Fonts

Some fonts today use multiple styles, FontAwesome 5 for example, which is supported by this library. The usage is pretty much the same as the standard Icon component:

`jsx
import Icon from 'react-native-vector-icons/FontAwesome5';

const myIcon1 = ; // Defaults to regular
const myIcon2 = ;
const myIcon3 = ; // Only in FA5 Pro
`

$3

All static methods from Icon is supported by multi-styled fonts.

| Prop | Description |
| ------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| getFontFamily | Returns the font family that is currently used to retrieve icons as text. Usage: const fontFamily = Icon.getFontFamily(style) |
| getImageSource | Returns a promise that resolving to the source of a bitmap version of the icon for use with Image component et al. Usage: const source = await Icon.getImageSource(name, size, color) |
| getImageSourceSync | Same as getImageSource but synchronous. Usage: const source = Icon.getImageSourceSync(name, size, color) |
| getRawGlyphMap | Returns the raw glyph map of the icon set. Usage: const glyphMap = Icon.getRawGlyphMap(style) |
| hasIcon | Checks if the name is valid in current icon set. Usage: const isNameValid = Icon.hasIcon(name, style) |
| getStyledIconSet | Use this to get a Icon component for a single style. Usage. const StyledIcon = Icon.getStyledIconSet(style) |

If no style argument is passed (or if it's invalid) the methods will default to a pre-defineds fallback.

$3

Icon.Button is supported, usage is just like Icon:

`jsx
import Icon from 'react-native-vector-icons/FontAwesome5';
const myButton = (

Login with Facebook

);
`

Custom Fonts

$3

Returns your own custom font based on the glyphMap where the key is the icon name and the value is either a UTF-8 character or it's character code. fontFamily is the name of the font NOT the filename. Open the font in Font Book.app or similar to learn the name. Optionally pass the third fontFile argument for android support, it should be the custom font file name.

`js
import { createIconSet } from 'react-native-vector-icons';
const glyphMap = { 'icon-name': 1234, test: '∆' };
const Icon = createIconSet(glyphMap, 'FontName', 'font-name.ttf');
`

$3

Convenience method to create a custom font based on a fontello config file. Don't forget to import the font as described above and drop the config.json somewhere convenient in your project.

`js
import { createIconSetFromFontello } from 'react-native-vector-icons';
import fontelloConfig from './config.json';
const Icon = createIconSetFromFontello(fontelloConfig);
`

$3

`js
import { createIconSetFromIcoMoon } from 'react-native-vector-icons';
import icoMoonConfig from './selection.json';
const Icon = createIconSetFromIcoMoon(
icoMoonConfig,
'LineAwesome',
'line-awesome.ttf'
);
`

Make sure you're using the _Download_ option in IcoMoon, and use the .json file that's included in the .zip you've downloaded. You'll also need to import the .ttf font file into your project, following the instructions above.

$3

`jsx
import { createMultiStyleIconSet } from 'react-native-vector-icons';

/*
* This is just example code, you are free to
* design your glyphmap and styles to your liking
*/

import glyphmap from './glyphmap.json';
/*
* glyphmap = {
* "style1": [
* "hello",
* "world"
* ],
* "style2": [
* "foo",
* "bar"
* ]
* }
*/

const glyphKeys = Object.keys(glyphmap); / ["style1", "style2"] /
const options = {
defaultStyle: 'style1',
glyphValidator: (name, style) => glyphKeys.indexOf(name) !== -1,
fallbackFamily: (name) => {
for (let i = 0; i < glyphKeys.length; i++) {
const style = glyphKeys[i];
if (glyphmap[style].indexOf(name) !== -1) {
return style;
}
}

/ Always return some family /
return glyphKeys[0];
}
};

/*
* The styles object consits of keys, which will be
* used as the styles later, and objects which are
* used as style objects for the font. The style
* should have unique characteristics for each font
* in order to ensure that the right one will be
* chosen. FontAwesome 5 uses font weight since
* 5.7.0 in order to diffirentiate the styles but
* other properties (like fontFamily) can be used.
* It's just a standard RN style object.
*/
const styles = {
style1: {
fontWeight: '700'
},
style2: {
fontWeight: '100'
}
};

const Icon = createMultiStyleIconSet(styles, options);

/ Uses default style (style1) /


/ Default style is style1 but this will fall back to style2 /

/ This will also fall back to style2 /

/ Regular use of style2 /

`

| option | Description | default |
| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------- |
| defaultStyle | The name of the style to be used if no style is supplied during rendering. | Object.keys(styles)[0] |
| fallbackFamily | Function for selecting a family if a glyph is not available. The function should accept the name of the glyph as a parameter. Returns the name if the family. | (name) => Object.keys(styles)[0] |
| glyphValidator | Function for validating that a glyph is available for a chosen style. It has name and style as parameters, in that order. Returns true if the glyph is valid or false if it's not. | (name, style) => true |

#### iOS

You have to manually make a reference of your .ttf on your xcodeproj Resources folder and in Info.plist.

Animation

React Native comes with an amazing animation library called Animated. To use it with an icon, simply create an animated component with this line: const AnimatedIcon = Animated.createAnimatedComponent(Icon). You can also use the higher level animation library react-native-animatable.

Usage Examples

$3

Try the IconExplorer project in Examples/IconExplorer folder, there you can also search for any icon.

!Screenshot of IconExplorer

$3

`js
import Icon from 'react-native-vector-icons/Ionicons';

function ExampleView(props) {
return ;
}
`

TabBar

Since TabBarIOS was removed from core in favor of @react-navigation/bottom-tabs, it is also removed as a convenience component from this library. Simply use the Icon instead, but don't forget to import and link to this project as described above first.

Below is an example taken from react-navigation:

`js
import { createBottomTabNavigator } from '@react-navigation/bottom-tabs';
import MaterialCommunityIcons from 'react-native-vector-icons/MaterialCommunityIcons';

const Tab = createBottomTabNavigator();

function MyTabs() {
return (
initialRouteName="Feed"
screenOptions={{
activeTintColor: '#e91e63',
}}
>
name="Feed"
component={Feed}
options={{
tabBarLabel: 'Home',
tabBarIcon: ({ color, size }) => (

),
}}
/>
name="Notifications"
component={Notifications}
options={{
tabBarLabel: 'Updates',
tabBarIcon: ({ color, size }) => (

),
tabBarBadge: 3,
}}
/>
name="Profile"
component={Profile}
options={{
tabBarLabel: 'Profile',
tabBarIcon: ({ color, size }) => (

),
}}
/>

);
}
`

$3

Since ToolbarAndroid was removed from core, it is also removed as a convenience component from this library. Simply use getImageSourceSync instead, but don't forget to import and link to this project as described above first.

`js
import ToolbarAndroid from '@react-native-community/toolbar-android';
import Icon from 'react-native-vector-icons/Ionicons';

const navIcon = Icon.getImageSourceSync('md-arrow-back', 24, 'white');
const overflowIcon = Icon.getImageSourceSync('md-more', 24, 'white');
const settingsIcon = Icon.getImageSourceSync('md-settings', 30, 'white');
const twitterIcon = Icon.getImageSourceSync('logo-twitter', 25, '#4099FF');

function ToolbarView(props) {
return (
title="Home"
titleColor="white"
navIcon={navIcon}
onIconClicked={props.navigator.pop}
actions={[
{
title: 'Settings',
icon: settingsIcon,
show: 'always',
},
{
title: 'Follow me on Twitter',
icon: twitterIcon,
show: 'ifRoom',
},
]}
overflowIcon={overflowIcon}
/>
);
}
`

$3

`js
import { Text } from 'react-native';
import Icon from 'react-native-vector-icons/Ionicons';

function ExampleView(props) {
return (

Lorem Ipsum

);
}
`

Generating Your Own Icon Set from a CSS File

If you already have an icon font with associated CSS file then you can easily generate a icon set with the generate-icon script.

$3

`
./node_modules/.bin/generate-icon path/to/styles.css --componentName=MyIcon --fontFamily=myicon > Components/MyIcon.js
`

$3

Any flags not listed below, like --componentName and --fontFamily, will be passed on to the template.

#### -p, --prefix

CSS selector prefix [default: ".icon-"]

#### -t, --template

Template in JS template string format [default: "./template/iconSet.tpl"]

For default template please provide --componentName and --fontFamily.

#### -o, --output

Save output to file, defaults to STDOUT

Changelog

Troubleshooting

#### The icons show up as a crossed out box on Android

- Make sure you've copied the font to android/app/src/main/assets/fonts.
- Delete the build folder with rm -rf android/app/build.
- Recompile the project.

#### Red screen with "Unrecognized font family" error on iOS

- Make sure you've added manually the reference of your .ttf on your xcodeproj Resources folder.
- Check that the font you are trying to use appears in Info.plist, if you've added the whole folder and it's blue in color, then you need to add it to the path.
- Check that the font is copied in the _Copy Bundle Resources_ in _Build Phases_.
- Delete the build folder with rm -rf ios/build
- Recompile the project.

#### Android build fails on Windows for no good reason

Both npm and android file hierarchies tend to get very deep and even worse when you combine them. Since Windows file system has a max length, long file name addresses will result in numerous errors including Execution failed for task ':react-native-vector-icons:processReleaseResources'`. So try to keep the path to your project folder as short as possible.

#### Wrong icons are shown after upgrading this package

You probably didn't update the font files linked to your native project after upgrading. However, this only applies to Android targets since iOS bundles the fonts when building the app (try to clean your build from Xcode if the problem exists). On android you can relink the project or you manually update the fonts. To have them automatically synced use the gradle approach.

#### Some icons are missing after upgrading this package

Sometimes vendors decides to remove some icons from newer releases, this has nothing to do with this package. If you depend on an older version of a font you can add it as a custom font.

License

This project is licenced under the MIT License.

Any bundled fonts are copyright to their respective authors and mostly under MIT or SIL OFL.