Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file lib/fontawesome/rails/helpers. To experiment with that code, run bin/console for an interactive prompt.

This gem is built for helping using awesome fonts 5+ in rails. If you use Bootstrap 4+, you can use Bootstrap's style classes.

Add this line to your application's Gemfile:

gem 'fontawesome-rails-helpers'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install fontawesome-rails-helpers

After yarn add @fortawesome/fontawesome-free and setup for using in rails 5+, referencing https://kelishrestha.medium.com/how-to-install-font-awesome-with-yarn-in-rails-6-0-c2506543c13d,

$ yarn add @fortawesome/fontawesome-free

In application.js,

import "@fortawesome/fontawesome-free/js/all";

In application.scss,

$fa-font-path: '@fortawesome/fontawesome-free/webfonts';
@import '@fortawesome/fontawesome-free/scss/fontawesome';
@import '@fortawesome/fontawesome-free/scss/solid';
@import '@fortawesome/fontawesome-free/scss/regular';
@import '@fortawesome/fontawesome-free/scss/brands';
@import '@fortawesome/fontawesome-free/scss/v4-shims';

and then, automatically you can use these helpers.

Minimal usage;

<%= fab_icon 'twitter' %>

With icon annotate,

<%= fab_icon 'twitter', text: 'Twitter' %>

With icon sizing,

<%= fab_icon 'twitter', text: 'Twitter', ratio: '2x' %> or
<%= fab_icon 'twitter fa-2x', text: 'Twitter' %> or

With icon animation, two options; spin or pulse

<%= fab_icon 'twitter fa-spin', text: 'Twitter', ratio: '2x'>
<%= fab_icon 'twitter fa-pulse', text: 'Twitter', ratio: '2x'>

With combining Bootstrap 4+ classes for icons with text,

<%= fas_icon('camera', text: 'camera', class: 'badge rounded-pill bg-primary') %>

With inline styles for icons with text,

<%= fas_icon('camera', text: 'camera', style: 'color: dodgerblue') %>

With inline styles or classes only for text,

<%= fas_icon('camera', text: 'camera', text_class: 'text-danger') %>
<%= fas_icon('camera', text: 'camera', text_style: 'color: dodgerblue') %>

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fontawesome-rails-helpers. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the MIT License.

Everyone interacting in the Fontawesome::Rails::Helpers project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.