ember-fontawesome

Font Awesome 5 Ember component using SVG with JS

• Introduction
  • Upgrading Font Awesome?
  • Get started
  • Learn about our new SVG implementation
  • Going from 0.0.x to 0.1.0
• Installation
  • Add more styles or Pro icons
  • Subsetting icons
• Usage
  • Template
  • Icon objects
• Features
  • Basic
  • Advanced
• Contributing to Development
  • Running
  • Running Tests
  • Building

Introduction

Hey there! We're glad you're here...

Upgrading Font Awesome?

If you've used Font Awesome in the past (version 4 or older) there are some things that you should learn before you dive in.

https://fontawesome.com/how-to-use/on-the-web/setup/upgrading-from-version-4

Get started

This package is for integrating with Ember.js. If you aren't using Ember then it's not going to help you. Head over to our "Get Started" page for some guidance.

https://fontawesome.com/how-to-use/on-the-web/setup/getting-started

Learn about our new SVG implementation

This package, under the hood, uses SVG with JS and the @fortawesome/fontawesome-svg-core library. This implementation differs drastically from the web fonts implementation that was used in version 4 and older of Font Awesome. You might head over there to learn about how it works.

https://fontawesome.com/how-to-use/on-the-web/advanced/svg-javascript-core

Going from 0.0.x to 0.1.0

See UPGRADING.md.

You might also be interested in the larger umbrella project UPGRADING.md

Installation

This project is an Ember addon. So we'll add that first:

$ ember install @fortawesome/ember-fontawesome

We need at least one style. Let's start with the free version of Solid.

$ npm i --save-dev @fortawesome/free-solid-svg-icons

or with Yarn

$ yarn add --dev @fortawesome/free-solid-svg-icons

Add more styles or Pro icons

Brands are separated into their own style and for customers upgrading from version 4 to 5 we have a limited number of Regular icons available.

Visit fontawesome.com/icons to search for free and Pro icons

$ npm i --save-dev @fortawesome/free-brands-svg-icons
$ npm i --save-dev @fortawesome/free-regular-svg-icons

Do this for each icon pack you'll use in your app. By default, all installed icon packs will be bundled into vendor.js and also added to the Font Awesome library (i.e. library.add())

If you are a Font Awesome Pro subscriber you can install Pro packages.

$ npm i --save-dev @fortawesome/pro-solid-svg-icons
$ npm i --save-dev @fortawesome/pro-regular-svg-icons
$ npm i --save-dev @fortawesome/pro-light-svg-icons

Using the Pro packages requires additional configuration.

Subsetting icons

If you want to include only a subset of icons from an icon pack, add a fontawesome configuration object to your applications options in ember-cli-build.js. The following example declares that all icons in free-solid-svg-icons should be included in the vendor.js bundle add added to the library, and for pro-light-svg-icons, only adjust, ambulance, and pencil-alt are to be included in the bundle and added to the library.

// ...
let app = new EmberApp(defaults, {
  // Add options here
  fontawesome: {
    icons: {
      'free-solid-svg-icons': 'all'
      'pro-light-svg-icons': [
        'adjust',
        'ambulance',
        'pencil-alt'
       ]
    }
})

Usage

Configuration

Out of the box, icons will use the Solid style unless a prefix is manually specified. To change the default to Regular or Light, add a fontawesome configuration object to your application's environment.js and set the defaultPrefix option.

module.exports = function(environment) {
  let ENV = {
    // Add options here
    fontawesome: {
      defaultPrefix: 'fal' // light icons
    }
  };
  // ...
  return ENV;
};

As a reminder, the free version of Font Awesome does not include a complete set of icons for any style other than Solid, so this setting is recommended only for Pro subscribers.

Template

This is what it can look like in your template:

{{fa-icon 'coffee'}}

Without a prefix specified, the default specified in environment.js (or fas, if none set) is assumed:

{{fa-icon 'square'}}

If you want to use an icon from any style other than the default, use prefix=.

{{fa-icon 'square' prefix='far'}}

Features

The following features are available as part of Font Awesome. Note that the syntax is different from our general web-use documentation.

Basic

Size:

{{fa-icon 'coffee' size='4x'}}

Fixed width:

{{fa-icon 'coffee' fixedWidth=true}}

Rotate:

{{fa-icon 'coffee' rotation=90}}
{{fa-icon 'coffee' rotation=180}}
{{fa-icon 'coffee' rotation=270}}

Flip horizontally, vertically, or both:

{{fa-icon 'coffee' flip='horizontal'}}
{{fa-icon 'coffee' flip='vertical'}}
{{fa-icon 'coffee' flip='both'}}

Spin and pulse animation:

{{fa-icon 'coffee' spin=true}}

Border:

{{fa-icon 'coffee' border=true}}

Pull left or right:

{{fa-icon 'coffee' pull='left'}}
{{fa-icon 'coffee' pull='right'}}

Advanced

Power Transforms:

{{fa-icon 'coffee' transform='shrink-6 rotate-30'}}

Masking:

{{fa-icon 'coffee' transform='shrink-6' mask='circle'}}

Symbols:

{{fa-icon 'coffee' symbol=true}}

Layers:

<span class="fa-layers fa-lg">
  {{fa-icon 'circle'}}
  {{fa-icon class='fa-inverse' 'check' transform='shrink-6'}}
</span>

Layers text:

<span class="fa-layers fa-lg">
  {{fa-icon 'circle'}}
  <span class="fa-layers-text">8</span>
</span>

Contributing to Development

• git clone <repository-url> this repository
• cd ember-fontawesome
• npm install

Running

• ember serve
• View the demo app at http://localhost:4200.

Running Tests

• npm test (Runs ember try:each to test addon against multiple Ember versions)
• ember test
• ember test --server

Building

• ember build

For more information on using ember-cli, visit https://ember-cli.com/.

Publishing a release

1. Edit package.json and update the version number
2. Add new contributors to the contributors section
3. Update the CHANGELOG.md
4. npm run build and npm test
5. npm publish
6. git add . && git commit -m 'Release VERSION'
7. git push
8. Create a new release with CHANGELOG details