@react-native-vector-icons/fontawesome5
TypeScript icon, indicating that this package has built-in type declarations

5.15.4-alpha.12 • Public • Published

FontAwesome 5

Table of Content

Usage

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

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'} solid />;
const icon = <FontAwesome5 name={'git'} brand />;

Valid types

Type Description
brand Uses the Brands font
light Uses the Light font (pro) or Regular (Free)
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. Therefore, the enum FA5Style is defined to help setting the style of the font:

const FA5Style = {
  regular: 0,
  light: 1,
  solid: 2,
  brand: 3,
};

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

import FontAwesome5, { FA5Style } from 'react-native-vector-icons/FontAwesome5';

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

Not passing a style will result in Regular style.

Upgrading to Pro

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

/@react-native-vector-icons/fontawesome5/

    Package Sidebar

    Install

    npm i @react-native-vector-icons/fontawesome5

    Weekly Downloads

    138

    Version

    5.15.4-alpha.12

    License

    MIT

    Unpacked Size

    124 kB

    Total Files

    15

    Last publish

    Collaborators

    • johnf
    • oblador