@react-native-vector-icons/fontawesome5

FontAwesome 5

Table of Content

• Usage
• Upgrading to Pro

Usage

Using the standard icons works just like the standard icons in this library.

import { FontAwesome5 } from "@react-native-vector-icons/fontawesome5/static";
// or with dynamic font loading (see the Expo setup guide for details)
import { FontAwesome5 } from "@react-native-vector-icons/fontawesome5";

const icon = <FontAwesome5 name="comments" />;

Something special about the FontAwesome5 class is that you can also pass props to change the style of the icon:

import { FontAwesome5 } from "@react-native-vector-icons/fontawesome5";

const icon = <FontAwesome5 name="comments" iconStyle="solid" />;
const icon = <FontAwesome5 name="git" iconStyle="brand" />;

Valid types

Type	Description
regular	Uses the Regular font
brand	Uses the Brands font
solid	Uses the Solid font

No specified type indicates Regular font.

getImageSource

getImageSource works a little different due to its native backend and how the font is separated into different files. An extra argument to specify the font style is required.

Use this to select which style the generated image should have:

import { FontAwesome5 } from "@react-native-vector-icons/fontawesome5";

FontAwesome5.getImageSource("solid", "comments", 30, "#000").then((source) =>
  this.setState({ image: source }),
);

Expo Config Plugin

This package ships an Expo config plugin. Add it to the plugins array in your app.json or app.config.js if you use static imports:

{
  "expo": {
    "plugins": ["@react-native-vector-icons/fontawesome5"]
  }
}

Upgrading to Pro

Use the @react-native-vector-icons/fontawesome5-pro package instead.