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
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', '~> 4.7.0'
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";
Rails Helper usage
In your view:icon('flag')
# => <i class="fa fa-flag"></i>
icon('flag', class: 'strong')
# => <i class="fa fa-flag strong"></i>
icon('flag', 'Font Awesome', id: 'my-icon', class: 'strong')
# => <i id="my-icon" class="fa fa-flag strong"></i> Font Awesome
Note: the icon helper can take a hash of options that will be passed to the contenttag helper
b. Compass without Rails
Install the gemgem 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 3.x
Prepend thefa
class to existing icons:3.x Syntax
<i class="icon-github"></i>
4.x Syntax
<i class="fa fa-github"></i>