Font_awesome5_rails

Overview

The Font Awesome 5 RailsGem provides Font-Awesome 5 web fonts, stylesheets, and javascripts as a Rails engine, compatible with the asset pipeline and offering Free icons from Font-Awesome. The gem allows for easy installation and usage of these icons within Rails applications.

Features

• Webfont with CSS: Option to install icons as a webfont with CSS.
• SVG with JS Installation: Provides the option to install icons as SVG with JS.
• Webpack Integration: Ability to install Font Awesome with webpack while still using helper functions from the gem.
• Helper Functions: Offers helper functions for easy integration of FontAwesome icons in Rails views.
• Multiple Icon Types: Supports different icon types like Solid, Regular, Light, Brand, Duotone, and Uploaded icons.
• New FA5 Features: Access to new features like animations and layered icons provided by Font Awesome 5.
• Backwards Compatibility: Maintains compatibility with the font-awesome-rails gem for seamless transition.

Install as webfont with CSS

Add the following line to your Gemfile:

gem 'font_awesome5_rails'

In your application.css, include the CSS file.

Install as SVG with JS

In your application.js, include the JavaScript file.

Install with webpack

Add Font Awesome to your package.json. Next, import the font in your application.js.

Install webfont with CSS Bundling and Propshaft

For Rails 7+ with CSS Bundling:

1. Add Font Awesome 5 to your package.json.
2. Copy the fonts to app/assets.
3. Include the font in your application.sass.scss.

Summary

The Font Awesome 5 RailsGem is a valuable resource for Rails developers looking to integrate Font Awesome icons into their applications seamlessly. With options for installation as webfont with CSS, SVG with JS, or webpack integration, along with helper functions and support for multiple icon types and new FA5 features, this gem simplifies the process of using Font Awesome icons in Rails projects.