FontAwesome::Sass
'font-awesome-sass' is a Sass-powered version of FontAwesome for your Ruby projects and plays nicely with Ruby on Rails, Compass, Sprockets, etc.
Refactored to support more Ruby environments with code and documentation humbly used from the excellent bootstrap-sass project by the Bootstrap team
Breaking Changes
With the update to Font Awesome 5.x there are some breaking changes that will effect your use of this gem. Some of the changes include:
- Icon name changes
- New icons
- The use of an icon style (
solid
,regular
, orbrands
)
You can find more detailed information on these changes on our Getting Started guide, our How to Use guide, and our Upgrading from Version 4 guide.
Installation
Please see the appropriate guide for your environment of choice:
- Ruby on Rails.
- Compass not on Rails.
a. Ruby on Rails
In your Gemfile include:
gem 'font-awesome-sass', '~> 5.15.1'
And then execute:
bundle install
Import the FontAwesome styles in your app/assets/stylesheets/application.css.scss
. The font-awesome-sprockets
file includes the sprockets assets helper Sass functions used for finding the proper path to the font file.
@import "font-awesome-sprockets";
@import "font-awesome";
If app/assets/stylesheets/application.css.scss
does not exist then rename app/assets/stylesheets/application.css
and add the @import
statements below the *= require
statements but outside of the comment block.
Rails Helper usage
With Font Awesome 5.x you now need to select what style of icon you want to use. Font Awesome 5.x has 3 styles:
- solid (
fas
) - regular (
far
) - brands (
fab
)
In your view:
icon('fas', 'flag')
# => <i class="fas fa-flag"></i>
icon('far', 'address-book', class: 'strong')
# => <i class="far fa-address-book strong"></i>
icon('fab', 'font-awesome', 'Font Awesome', id: 'my-icon', class: 'strong')
# => <i id="my-icon" class="fab fa-font-awesome strong"></i> Font Awesome
Note: the icon helper can take a hash of options that will be passed to the content_tag helper
b. Compass without Rails
Install the gem
gem install font-awesome-sass
If you have an existing Compass project:
# config.rb:
require 'font-awesome-sass'
Import the FontAwesome styles
@import "font-awesome-compass";
@import "font-awesome";
Upgrading from FontAwesome::Sass 4.x
Prepend the style of the icon you want to use (fas
, far
, fab
) class to existing icons:
4.x Syntax
<i class="fa fa-github"></i>
5.x Syntax (GitHub icon exists in the Brands style)
<i class="fab fa-github"></i>