UNPKG

3.15 kBMarkdownView Raw
1<a href="https://fontawesome.com">
2 <img align="right" width="100" height="100" alt="Official Javascript Component" src="https://img.fortawesome.com/349cfdf6/official-javascript-component.svg">
3</a>
4
5# react-fontawesome
6
7[![npm](https://img.shields.io/npm/v/@fortawesome/react-fontawesome.svg?style=flat-square)](https://www.npmjs.com/package/@fortawesome/react-fontawesome)
8
9> Font Awesome 5 React component using SVG with JS
10
11<!-- toc -->
12
13- [Documentation](#documentation)
14- [How to Help](#how-to-help)
15- [Contributors](#contributors)
16- [Releasing this project (only project owners can do this)](#releasing-this-project-only-project-owners-can-do-this)
17
18<!-- tocstop -->
19
20## Documentation
21
22`react-fontawesome` now supports `forwardRef` for version `0.2.x` or above. This was a breaking change so if you are using React older than version 16.3.0 choose the `0.1.x` version of this component.
23
24## Compatibility
25| React version | react-fontawesome version |
26| - | - |
27| < 16.3.0 | 0.1.x |
28| >= 16.3.0 | 0.2.x |
29
30Official documentation is hosted at fontawesome.com:
31
32[Check it out here](https://fontawesome.com/v6/docs/web/use-with/react/)
33
34## How to Help
35
36Review the following docs before diving in:
37
38- [CONTRIBUTING.md](CONTRIBUTING.md)
39- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
40
41And then:
42
431. Check the existing issue and see if you can help!
44
45## Contributors
46
47The following contributors have either helped to start this project, have contributed
48code, are actively maintaining it (including documentation), or in other ways
49being awesome contributors to this project. **We'd like to take a moment to recognize them.**
50
51| Name | GitHub |
52| ----------------- | --------------------------------------------------------- |
53| Nate Radebaugh | [@NateRadebaugh](https://github.com/NateRadebaugh) |
54| Kirk Ross | [@kirkbross](https://github.com/kirkbross) |
55| Prateek Goel | [@prateekgoel](https://github.com/prateekgoel) |
56| Naor Torgeman | [@naortor](https://github.com/naortor) |
57| Matthew Hand | [@mmhand123](https://github.com/mmhand123) |
58| calvinf | [@calvinf](https://github.com/calvinf) |
59| Bill Parrott | [@chimericdream](https://github.com/chimericdream) |
60| Mike Lynch | [@baelec](https://github.com/baelec) |
61| Lukáš Rod | [@rodlukas](https://github.com/rodlukas) |
62| Proudust | [@proudust](https://github.com/proudust) |
63| Tiago Sousa | [@TiagoPortfolio](https://github.com/TiagoPortfolio) |
64| Alexey Victorov | [@AliMamed](https://github.com/AliMamed) |
65| Calum Smith | [@cpmsmith](https://github.com/cpmsmith) |
66| Font Awesome Team | [@FortAwesome](https://github.com/orgs/FortAwesome/people)|
67
68If we've missed someone (which is quite likely) submit a Pull Request to us and we'll get it resolved.
69
70## Releasing this project (only project owners can do this)
71
72See [DEVELOPMENT.md](DEVELOPMENT.md#release)