[![ukFontAwesome](https://www.septdir.com/images/solutions/projects/6/en-GB/cover.jpg)](https://www.septdir.com/solutions/uikit/icons/ukfontawesome)  
[![Information](https://img.shields.io/badge/information--0.svg?style=for-the-badge&colorA=555&colorB=555&logoWidth=20)](https://www.septdir.com/solutions/uikit/icons/ukfontawesome)
[![Support](https://img.shields.io/badge/support--0.svg?style=for-the-badge&colorA=555&colorB=555&logoWidth=20)](https://www.septdir.com/support#solution=ukfontawesome)
[![Demo](https://img.shields.io/badge/demo--0.svg?style=for-the-badge&colorA=555&colorB=555&logoWidth=20)](https://uikit.septdir.com/ukfontawesome)
[![Download](https://img.shields.io/github/release/SeptdirWorkshop/ukFontAwesome.svg?style=for-the-badge&colorA=555&colorB=1e87f0&label=download)](https://www.septdir.com/solutions/download?element=uikit_fa_icons)

JavaScript package allowing to use the FontAwesome icon set in the UIkit Framework

## Getting started
### Download
You have the following options to get ukFontAwesome:
* Download the latest release from [our site](https://www.septdir.com/solutions/download?element=uikit_fa_icons)
* Install with npm `npm install @septdirworkshop/ukfontawesome`
* Clone the repo `git clone git://github.com/SeptdirWorkshop/ukFontAwesome.git`

### Connect JavaScript
You can connect the following icon sets after UIkit library script:
* `uikit-fa-all-icons.js` - All icon sets in one file
* `uikit-fa-brands-icons.js` - Brands icon set
* `uikit-fa-regular-icons.js` - Regular icon set
* `uikit-fa-solid-icons.js` - Solid icon set

### Usage
* Make sure to include the UIkit and ukFontAwesome scripts
* Select the desired icon from [icons list](https://uikit.septdir.com/ukfontawesome)
* Add the `uk-icon` attribute with `icon: NAME` parameter to a `<span>` or `<a>` element  in the same way as using standard [UIkit icons](https://getuikit.com/docs/icon)

## License
* ukFontAwesome is distributed under the [MIT license](https://opensource.org/licenses/MIT)
* The original Font Awesome icons license is  [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/)
* The original Font Awesome font license is [SIL OFL 1.1](https://scripts.sil.org/OFL)

The original Font Awesome font created by [Dave Gandy](http://twitter.com/davegandy) can be found at https://fontawesome.com