A React component for the font-awesome icon library.
npm install --save react-fontawesome
var React = ;var FontAwesome = ;React;
- No dependencies (other than React)
- Simple API that mirrors Font Awesome's class names.
- Supports all Font Awesome modifiers (see API below).
- Add your own
classNames, styles and other props (all additional props are passed directly to the component).
Note: This component does not include any of the Font Awesome CSS or fonts, so you'll need to make sure to include those on your end somehow, either by adding them to your build process or linking to CDN versions.
var React = ;var FontAwesome = ;var MyComponent = React;
See the API docs for full documentation.
Pull requests welcome!
Run the test suite with
npm test and format your code with
npm run format. Make sure tests are passing and that you write tests for new features and document changes to the API with updates to the JSDocs.
Before you submit your pull request, run
npm run dist to build the project and commit the changes.