No commit activity in last 3 years
No release in over 3 years
Fork of Font-Awesome SASS which focuses on the use of semantic class names
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

Runtime

~> 3.2
 Project Readme

#Semantic FontAwesome Sass 'semantic-fa-sass' is a fork of 'font-awesome-sass', which focuses on the use of semantic class names. For example, instead if writing this:

Connection Status: <i class="fa fa-times"></i>

You can instead write:

ConnectionStatus: <i class="connection-status inactive"></i>

Usage

To use Semantic FontAwesome icons, you simply use the following mixin:

.connection-status {
    .active {
        @include s-fa-icon(signal);
    }
    .inactive {
        @include s-fa-icon(times);
    }
}

This will then compile to:

...
.connection-status .active, .connection-status .inactive {
  display: inline-block;
  font: normal normal normal 14px/1 FontAwesome;
  font-size: inherit;
  text-rendering: auto;
  -webkit-font-smoothing: antialiased;
  -moz-osx-font-smoothing: grayscale;
  transform: translate(0, 0);
}
...
.connection-status .inactive:before {
  content: "";
}

.connection-status .active:before {
  content: "";
}
...

This also has the added benefit of only rendering the css for icons you actually use!

If you want to use other font-awesome classes, such as fa-spin, fa-5x, fa-border etc, you simply add them in the mixin:

.foo {
    @include s-fa-icon(mobile 5x spin border right)
}

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 'semantic-fa-sass', '~> 1.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";

b. Compass without Rails

Install the gem

gem install semantic-fa-sass

If you have an existing Compass project:

# config.rb:
require 'semantic-fa-sass'

Import the FontAwesome styles

@import "font-awesome-compass";
@import "font-awesome";