@fortawesome/react-fontawesome

  • Version 0.2.1
  • Published
  • 37.7 kB
  • 1 dependency
  • MIT license

Install

npm i @fortawesome/react-fontawesome
yarn add @fortawesome/react-fontawesome
pnpm add @fortawesome/react-fontawesome

Overview

Official React component for Font Awesome

Index

Functions

function FontAwesomeIcon

FontAwesomeIcon: (props: FontAwesomeIconProps) => JSX.Element;

    Interfaces

    interface FontAwesomeIconProps

    interface FontAwesomeIconProps
    extends BackwardCompatibleOmit<
    SVGAttributes<SVGSVGElement>,
    'children' | 'mask' | 'transform'
    >,
    RefAttributes<SVGSVGElement> {}

      property beat

      beat?: boolean;

        property beatFade

        beatFade?: boolean;

          property border

          border?: boolean;

            property bounce

            bounce?: boolean;

              property className

              className?: string;

                property color

                color?: string;

                  property fade

                  fade?: boolean;

                    property fixedWidth

                    fixedWidth?: boolean;

                      property flip

                      flip?: FlipProp;

                        property icon

                        icon: IconProp;

                          property inverse

                          inverse?: boolean;

                            property listItem

                            listItem?: boolean;

                              property mask

                              mask?: IconProp;

                                property maskId

                                maskId?: string;

                                  property pull

                                  pull?: PullProp;

                                    property pulse

                                    pulse?: boolean;

                                      property rotation

                                      rotation?: RotateProp;

                                        property shake

                                        shake?: boolean;

                                          property size

                                          size?: SizeProp;

                                            property spin

                                            spin?: boolean;

                                              property spinPulse

                                              spinPulse?: boolean;

                                                property spinReverse

                                                spinReverse?: boolean;

                                                  property style

                                                  style?: CSSProperties;

                                                    property swapOpacity

                                                    swapOpacity?: boolean;

                                                      property symbol

                                                      symbol?: FaSymbol;

                                                        property tabIndex

                                                        tabIndex?: number;

                                                          property title

                                                          title?: string;

                                                            property titleId

                                                            titleId?: string;

                                                              property transform

                                                              transform?: string | Transform;

                                                                Type Aliases

                                                                type BackwardCompatibleOmit

                                                                type BackwardCompatibleOmit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;

                                                                  type Props

                                                                  type Props = FontAwesomeIconProps;
                                                                  • Deprecated

                                                                    use FontAwesomeIconProps

                                                                  Package Files (1)

                                                                  Dependencies (1)

                                                                  Dev Dependencies (36)

                                                                  Peer Dependencies (2)

                                                                  Badge

                                                                  To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                                  You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@fortawesome/react-fontawesome.

                                                                  • Markdown
                                                                    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@fortawesome/react-fontawesome)
                                                                  • HTML
                                                                    <a href="https://www.jsdocs.io/package/@fortawesome/react-fontawesome"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>