@fortawesome/react-fontawesome
Version:
Official React component for Font Awesome
90 lines (62 loc) • 4.5 kB
Markdown
<a href="https://fontawesome.com">
<img align="right" width="100" height="100" alt="Official Javascript Component" src="https://img.fortawesome.com/349cfdf6/official-javascript-component.svg">
</a>
# react-fontawesome
[](https://www.npmjs.com/package/@fortawesome/react-fontawesome)
> Font Awesome React component using SVG with JS
<!-- toc -->
- [react-fontawesome](#react-fontawesome)
- [Documentation](#documentation)
- [Compatibility](#compatibility)
- [How to Help](#how-to-help)
- [Contributors](#contributors)
- [Releasing this project (only project owners can do this)](#releasing-this-project-only-project-owners-can-do-this)
<!-- tocstop -->
## 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](https://docs.fontawesome.com/web/use-with/react)
## How to Help
Review the following docs before diving in:
- [CONTRIBUTING.md](CONTRIBUTING.md)
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
And then:
- Check the [existing issues](https://github.com/FortAwesome/react-fontawesome/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](https://github.com/NateRadebaugh) |
| Kirk Ross | [@kirkbross](https://github.com/kirkbross) |
| Prateek Goel | [@prateekgoel](https://github.com/prateekgoel) |
| Naor Torgeman | [@naortor](https://github.com/naortor) |
| Matthew Hand | [@mmhand123](https://github.com/mmhand123) |
| calvinf | [@calvinf](https://github.com/calvinf) |
| Bill Parrott | [@chimericdream](https://github.com/chimericdream) |
| Mike Lynch | [@baelec](https://github.com/baelec) |
| Lukáš Rod | [@rodlukas](https://github.com/rodlukas) |
| Proudust | [@proudust](https://github.com/proudust) |
| Tiago Sousa | [@TiagoPortfolio](https://github.com/TiagoPortfolio) |
| Alexey Victorov | [@AliMamed](https://github.com/AliMamed) |
| Calum Smith | [@cpmsmith](https://github.com/cpmsmith) |
| squiaios | [@squiaios](https://github.com/squiaios) |
| WyvernDrexx | [@WyvernDrexx](https://github.com/WyvernDrexx) |
| Jon Defresne | [@jdufresne](https://github.com/jdufresne) |
| Charles Harwood | [@charles4221](https://github.com/charles4221) |
| Font Awesome Team | [@FortAwesome](https://github.com/orgs/FortAwesome/people) |
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](DEVELOPMENT.md#release)