https://github.com/danawoodman/react-fontawesome

A React Font Awesome component.
https://github.com/danawoodman/react-fontawesome

List: react-fontawesome

component components font font-awesome icon javascript props react reactjs ui

Last synced: about 8 hours ago
JSON representation

A React Font Awesome component.

• Host: GitHub
• URL: https://github.com/danawoodman/react-fontawesome
• Owner: danawoodman
• License: mit
• Created: 2015-02-10T06:10:08.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2022-12-30T19:01:10.000Z (almost 2 years ago)
• Last Synced: 2024-10-29T15:48:57.815Z (about 1 month ago)
• Topics: component, components, font, font-awesome, icon, javascript, props, react, reactjs, ui
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/react-fontawesome
• Size: 591 KB
• Stars: 667
• Watchers: 10
• Forks: 72
• Open Issues: 9
• Metadata Files:
  • Readme: readme.md
  • Changelog: changelog.md
  • License: license

Awesome Lists containing this project

• awesome-react - react-fontawesome - A React Font Awesome component.  (UI Components / Icons)

README

        
# react-fontawesome

[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)

[![Travis CI build status](https://img.shields.io/travis/danawoodman/react-fontawesome.svg)](https://travis-ci.org/danawoodman/react-fontawesome)

[![Dependency Status](https://img.shields.io/david/danawoodman/react-fontawesome.svg)](https://david-dm.org/danawoodman/react-fontawesome)

[![View on npm](https://img.shields.io/npm/dm/react-fontawesome.svg)](https://www.npmjs.com/package/react-fontawesome)

[![View on npm](https://img.shields.io/npm/v/react-fontawesome.svg)](https://www.npmjs.com/package/react-fontawesome)

> A React component for the font-awesome icon library.

**If you are using Font Awesome v5+, please use [the official React component!](https://github.com/FortAwesome/react-fontawesome). `react-fontawesome` does not support FontAwesome v5!**

**This project is no longer actively maintained. Please try and use the official component above if you are able!**

## Install

```bash

npm install --save react-fontawesome

```

_**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](https://www.bootstrapcdn.com/fontawesome/)._

### Using CDN version

The fastest way to get started is to import FontAwesome with a link tag in your page's ``:

```html

```

You can change the version number to use whatever version of FontAwesome you'd like.

### Using with Webpack

If you're using WebPack, you will need to install FontAwesome, import the FontAwesome Sass/Less, and configure the font path. Please see this [blog post](https://medium.com/@chanonroy/webpack-2-and-font-awesome-icon-importing-59df3364f35c) on how to get Webpack and FontAwesome working together.

## Usage

```js

var React = require('react')

var FA = require('react-fontawesome')

React.render(, document.body)

```

## Features

* No dependencies (other than React)

* Simple API that mirrors Font Awesome's class names.

* Supports all Font Awesome modifiers (see [API](#API) below).

* Make use of Css Modules

* Add your own `className`s, styles and other props (all additional props are passed directly to the component).

## Examples

**Regular usage**

```js

var React = require('react')

var FontAwesome = require('react-fontawesome')

var MyComponent = React.createClass({

  render: function() {

    return (

      

    )

  },

})

```

**With the use of CSS Modules**

```js

import React from 'react'

import FontAwesome from 'react-fontawesome'

import faStyles from 'font-awesome/css/font-awesome.css'

var MyComponent = React.createClass({

  render: function() {

    return (

      

    )

  },

})

```

The above will create output like this:

```



```

## API

See [the API docs](api.md) for full documentation.

## Contributing

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.

## License

[MIT](license) © [Dana Woodman][author]

[author]: https://github.com/danawoodman