Skip to content

ErbijApp/vector-icons

 
 

Repository files navigation

@expo/vector-icons

This library is a compatibility layer around @oblador/react-native-vector-icons to work with the Expo asset system. If you're using React Native without Expo, you have no need for this library -- carry on! (or maybe check out Expo).

👀: this library does not provide access to react-native-vector-icon's Icon.getImageSource() function for generating images from icons at runtime (for context on why, see this issue). If you find yourself needing an icon in the form of an image rather than text, you should generate that image yourself and bundle it with your app.

Resources

Usage

This library is part of the expo package, so if you are using expo you can simply use it like so

import React from 'react';
import { Ionicons } from '@expo/vector-icons';

export default class IconExample extends React.Component {
  render() {
    return <Ionicons name="md-checkmark-circle" size={32} color="green" />;
  }
}

Upgrading to FontAwesome5 Pro

In order to you use the FontAwesome 5 Pro icons, you will need to download the Pro fonts.

First you need your FontAwesome npm token which can be obtained by logging into your account and then access the Services tab.

Next, configure @fortawesome scope to use the correct server address and your token, as described here.

Finally, run cd node_modules/@expo/vector-icons && npm run fa5pro to download and install the fonts.

If you already had @fortawesome configured (via an .npmrc file or by using npm config set) before you installed this package, the fonts will already have been installed.

Use FontAwesome5Pro icons like so

import React from 'react';
import { FontAwesome5Pro } from '@expo/vector-icons';

export default class IconExample extends React.Component {
  render() {
    return (
      <FontAwesome5Pro light name="check-square" size={32} color="green" />
    );
  }
}

for more usage see Expo icons documentation

Packages

No packages published

Languages

  • TypeScript 54.2%
  • JavaScript 27.4%
  • CSS 11.7%
  • Shell 4.2%
  • HTML 2.5%