6.6.0-alpha.38 • Published 9 months ago

@react-native-vector-icons/fontawesome6-pro v6.6.0-alpha.38

Weekly downloads
-
License
MIT
Repository
github
Last release
9 months ago

FontAwesome 6 Pro

Installing the Pro Fonts

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

Run yarn fa6-upgrade and enter the token when asked to in order to upgrade to the Pro version. It will install the fonts in your repo in the rnvi-fonts directory but the folder can be customized by setting it when executing the command: yarn fa6-upgrade [destination].

Manually

If the shell script does not work you can install the Pro version manually. All you really need to do is adding the Pro fonts to the rnvi-fonts directory.

Usage

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

import FontAwesome6Pro from '@react-native-vector-icons/fontawesome6-pro';

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

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

import FontAwesome6Pro from '@react-native-vector-icons/fontawesome6-pro';

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

Valid types

TypeDescription
brandUses the Brands font
solidUses the Solid font
lightUses the Light font
thinUses the Thin font
duotoneUses the Duotone font
sharpSolidUses the Sharp Solid font
sharpThinUses the Sharp Thin font
sharpLightUses the Sharp Light font
sharpUses the Sharp 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 FA6Style is defined to help setting the style of the font:

const FA6Style = {
  regular: 'regular',
  light: 'light',
  solid: 'solid',
  brand: 'brand',
  sharp: 'sharp',
  sharpThin: 'sharpThin',
  sharpLight: 'sharpLight',
  sharpSolif: 'sharpSolid',
  duotone: 'duotone',
  thin: 'thin',
};

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

import FontAwesome6, { FA6Style } from 'react-native-vector-icons/FontAwesome6';

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

Not passing a style will result in Regular style.