iconfonts

Icon fonts

Fine-tuned icon fonts integration for Sass, Less and Stylus.

Featuring the following icon sets:

• Elusive
• FontAwesome
• Ionicons
• Foundation Icons General

Install

Manual

Get the files you need over at /stylesheets/ and put it in your project.

Bower

Using bower makes files available via bower_components/iconfonts/stylesheets/___.scss.

bower install iconfonts

NPM

Using bower makes files available via node_modules/iconfonts/stylesheets/___.scss.

npm install iconfonts

Why is it needed?

This lets you use CSS definitions only for the icons you need, on the elements that you need them.

The CSS files that these fonts provide usually give you a lot of cruft, and defines all the classes in one giant file.

/* CSS */
.fa-user:before { content: '\f007'; }
.fa-film:before { content: '\f008'; }
.fa-th-large:before { content: '\f009'; }
... and 300 more

/* HTML */
<button class="btn btn-plus"><i class="fa fa-plus"></i> Add user</button>

I prefer to not have them in my CSS files unless I need them. This project lets you do that.

/* Stylus */
.btn-plus {
  &:before { fa-icon: "plus"; margin-right: 10px; }
}

/* HTML */
<button class="btn-plus">Add user</button>

Setup

SCSS

@import 'font-awesome';

/* embeds the @font-face. use this only once. */
@include fa-font();

button:before {
  @include fa-icon("music", 14px);
}

See a Sass file for more info.

SCSS on Rails

If you're on Rails (with sass-rails) and prefer to keep the files in your project, download the font files to vendor/assets/images/. Afterwards, use xx-font-rails() instead of xx-font() to embed the @font-face. Usage is otherwise the same as above.

@import 'font-awesome';
@include fa-font-rails();

Stylus

@require font-awesome

fa-font()

button:before
  fa-icon("music", 14px)

See a stylus file for more info.

Less

@import 'font-awesome';
.fa-font();

button:before {
  .fa-icon("music");
  font-size: 14px;
}

See a less file for more info.

Less on Rails

If you're on Rails (with less-rails) and prefer to keep the files in your project, download the font files to vendor/assets/images/. Afterwards, use xx-font-rails() instead of xx-font() to embed the @font-face. Usage is otherwise the same as above.

@import 'font-awesome';
.fa-font-rails();

Thanks

Iconfonts © 2014+, Rico Sta. Cruz. Released under the MIT License.
Authored and maintained by Rico Sta. Cruz with help from contributors.

ricostacruz.com  ·  GitHub @rstacruz  ·  Twitter @rstacruz

Changelog

v0.2.0

June 26, 2014

• Update file comments to link to project page.
• Officially support node-sass.
• Ionicons: update comments to point to correct site URL.
• SCSS: add xxx-font-rails() mixin for Rails integration.
• Less: add xxx-font-rails() mixin for Rails integration.