react-fontawesome

react-fontawesome

A React component for the font-awesome icon library.

• Simple API that mirrors Font Awesome's classes.
• 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).
• Standard, non-ES6 JavaScript, so should work most places without a build step.
  • Packaged as a CommonJS/npm module.
  • Doesn't use JSX so no transforms needed.
  • Does not require a specific build process/tool other than something that supports npm.

Usage

var React = require('react');
var FontAwesome = require('react-fontawesome');

var MyComponent = React.createClass({
  render: function () {
    return (
      <FontAwesome
        className='super-crazy-colors'
        name='rocket'
        size='2x'
        spin
        style={{ textShadow: '0 1px 0 rgba(0, 0, 0, 0.1)' }}
      />
    );
  }
});

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 the CDN versions.

API

Prop Name	Type	Default	Description
border	boolean	false
fixedWidth	boolean	false
flip	string	''	Choices: 'horizontal' or 'vertical'
inverse	boolean	false
name	string	''	Required: 'check', 'cloud', 'person', etc... (e.g. any Font Awesome icon class name, minus the fa- prefix)
pulse	boolean	false
rotate	string	''	Choices: '90', '180' or '270'
size	string	''	Choices: 'lg', '2x', '3x', '4x' or '5x'
spin	boolean	false
stack	string	''	Choices: '1x' or '2x'

Contributing

Pull requests welcome!

Please use the .editorconfig, .jsfmtrc and .jshintrc configurations in your editor to ensure proper formatting.

Run the test suite with npm test, make sure tests are passing and that you write tests for new features.

Credits

Created by Dana Woodman of BIG. Inspired by react-fa.

License

Licensed under the generous MIT license.

Changelog

v0.2.5

• Allow React to be 0.12 or greater, actually fixing #2.