Skip to content

Latest commit

 

History

History
33 lines (27 loc) · 2.27 KB

README.md

File metadata and controls

33 lines (27 loc) · 2.27 KB
Raw

ukFontAwesome
Information Support Demo Download

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
  • 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
  • Add the uk-icon attribute with icon: NAME parameter to a <span> or <a> element in the same way as using standard UIkit icons

License

  • ukFontAwesome is distributed under the MIT license
  • The original Font Awesome icons license is CC BY 4.0
  • The original Font Awesome font license is SIL OFL 1.1

The original Font Awesome font created by Dave Gandy can be found at https://fontawesome.com