react-fontawesome

Font Awesome React component using SVG with JS

• react-fontawesome
  • Documentation
  • Compatibility
  • How to Help
  • Contributors
  • Releasing this project (only project owners can do this)

Documentation

Version 3.0.0 is a major update for react-fontawesome with the library being rewritten from plain JS to TypeScript, amongst a number of performance improvements and optimisations to the FontAwesomeIcon React component.

While it is a major update, there should be no breaking changes aside from those noted in the Compatibility section below.

Compatibility

With the release of FontAwesome v7, we have marked v5 as End-of-Life. Both v6 and v7 will continue to be supported.

In react-fontawesome v3.0.0 we have also dropped support for End-of-Life versions of React and Node.js as well as IE11 browser support.

If you need to use react-fontawesome with legacy versions, please consult the table below.

| React version | react-fontawesome version | FontAwesome Core versions | Node versions | | ------------- | ------------------------- | ------------------------- | ---------------- | | >= 18.0.0 | 3.x.x | 6.x, 7.x | 20.x, 22.x, 24.x | | >= 16.3.0 | 0.2.x | 5.x, 6.x, 7.x | 18.x, 20.x | | < 16.3.0 | 0.1.x | 5.x, 6.x | 14.x, 16.x |

Official documentation is hosted at fontawesome.com:

Check it out here

How to Help

Review the following docs before diving in:

• CONTRIBUTING.md
• CODE_OF_CONDUCT.md

And then:

• Check the existing issues and see if you can help!

Contributors

The following contributors have either helped to start this project, have contributed code, are actively maintaining it (including documentation), or in other ways being awesome contributors to this project. We'd like to take a moment to recognize them.

| Name | GitHub | | ----------------- | ---------------------------------------------------------- | | Nate Radebaugh | @NateRadebaugh | | Kirk Ross | @kirkbross | | Prateek Goel | @prateekgoel | | Naor Torgeman | @naortor | | Matthew Hand | @mmhand123 | | calvinf | @calvinf | | Bill Parrott | @chimericdream | | Mike Lynch | @baelec | | Lukáš Rod | @rodlukas | | Proudust | @proudust | | Tiago Sousa | @TiagoPortfolio | | Alexey Victorov | @AliMamed | | Calum Smith | @cpmsmith | | squiaios | @squiaios | | WyvernDrexx | @WyvernDrexx | | Jon Defresne | @jdufresne | | Charles Harwood | @charles4221 | | Font Awesome Team | @FortAwesome |

If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved.

Releasing this project (only project owners can do this)

See DEVELOPMENT.md