Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bokmann/font-awesome-rails
the font-awesome font bundled as an asset for the rails asset pipeline
https://github.com/bokmann/font-awesome-rails
List: font-awesome-rails
Last synced: about 2 months ago
JSON representation
the font-awesome font bundled as an asset for the rails asset pipeline
- Host: GitHub
- URL: https://github.com/bokmann/font-awesome-rails
- Owner: bokmann
- License: mit
- Created: 2012-03-08T02:06:59.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2023-10-04T20:54:52.000Z (12 months ago)
- Last Synced: 2024-05-01T12:24:11.180Z (5 months ago)
- Language: HTML
- Homepage: http://fortawesome.github.com/Font-Awesome/
- Size: 4.5 MB
- Stars: 1,861
- Watchers: 39
- Forks: 243
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
> [!NOTE]
> For Font Awesome 5 or 6 support, please consider [font-awesome-sass](https://github.com/FortAwesome/font-awesome-sass).
---
# font-awesome-rails
[](https://rubygems.org/gems/font-awesome-rails)
[](https://github.com/bokmann/font-awesome-rails/actions?query=workflow%3ACI)
[](https://rubygems.org/gems/font-awesome-rails)
font-awesome-rails provides the
[Font-Awesome](https://fontawesome.com) web fonts and
stylesheets as a Rails engine for use with the asset pipeline.
## Installation
Add this to your Gemfile:
```ruby
gem "font-awesome-rails"
```
and run `bundle install`.
## Usage
In your `application.css`, include the css file:
```css
/*
*= require font-awesome
*/
```
Then restart your webserver if it was previously running.
Congrats! You now have scalable vector icon support. Pick an icon and check out the
[FontAwesome Examples](https://fontawesome.com/icons).
### Sass Support
If you prefer [SCSS](http://sass-lang.com/documentation/file.SASS_REFERENCE.html), add this to your
`application.css.scss` file:
```scss
@import "font-awesome";
```
If you use the
[Sass indented syntax](http://sass-lang.com/docs/yardoc/file.INDENTED_SYNTAX.html),
add this to your `application.css.sass` file:
```sass
@import font-awesome
```
### Helpers
There are also some helpers (`fa_icon` and `fa_stacked_icon`) that make your
views _icontastic!_
```ruby
fa_icon "camera-retro"
# =>
fa_icon "camera-retro", text: "Take a photo"
# => Take a photo
fa_icon "chevron-right", text: "Get started", right: true
# => Get started
fa_icon "quote-left 4x", class: "text-muted pull-left"
# =>
content_tag(:li, fa_icon("check li", text: "Bulleted list item"))
# =>
Bulleted list item
```
```ruby
fa_stacked_icon "twitter", base: "square-o"
# =>
# =>
# =>
# =>
fa_stacked_icon "dollar inverse", base: "circle", class: "fa-5x"
# =>
# =>
# =>
# =>
fa_stacked_icon "terminal inverse", base: "square", class: "pull-right", text: "Hi!"
# =>
# =>
# =>
# => Hi!
```
## Misc
### Rails engines
When building a Rails engine that includes font-awesome-rails as a dependency,
be sure to `require "font-awesome-rails"` somewhere during the initialization of
your engine. Otherwise, Rails will not automatically pick up the load path of
the font-awesome-rails assets and helpers ([source 1](https://github.com/bokmann/font-awesome-rails/issues/130#issuecomment-95308175), [source 2](https://bibwild.wordpress.com/2013/02/27/gem-depends-on-rails-engine-gem-gotcha-need-explicit-require/), [source 3](http://stackoverflow.com/questions/5159607/rails-engine-gems-dependencies-how-to-load-them-into-the-application/5850503#5850503)).
### Deploying to sub-folders
It is sometimes the case that deploying a Rails application to a production
environment requires the application to be hosted at a sub-folder on the server.
This may be the case, for example, if Apache HTTPD or Nginx is being used as a
front-end proxy server, with Rails handling only requests that come in to a sub-folder
such as `http://example.com/myrailsapp`. In this case, the
FontAwesome gem (and other asset-serving engines) needs to know the sub-folder,
otherwise you can experience a problem roughly described as ["my app works
fine in development, but fails when I deploy
it"](https://github.com/bokmann/font-awesome-rails/issues/74).
To fix this, set the *relative URL root* for the application. In the
environment file for the deployed version of the app, for example
`config/environments/production.rb`,
set the config option `action_controller.relative_url_root`:
MyApp::Application.configure do
...
# set the relative root, because we're deploying to /myrailsapp
config.action_controller.relative_url_root = "/myrailsapp"
...
end
The default value of this variable is taken from `ENV['RAILS_RELATIVE_URL_ROOT']`,
so configuring the environment to define `RAILS_RELATIVE_URL_ROOT` is an alternative strategy.
In addition you need to indicate the subfolder when you *precompile* the assets:
RAILS_ENV=production bundle exec rake assets:precompile RAILS_RELATIVE_URL_ROOT=/myrailsapp
### Rails 3.2
**Note:** In Rails 3.2, make sure font-awesome-rails is outside the bundler asset group
so that these helpers are automatically loaded in production environments.
## Versioning
Versioning follows the core releases of Font-Awesome which follows Semantic
Versioning 2.0 as defined at . We will do our best not to
make any breaking changes until Font-Awesome core makes a major version bump.
## License
* The [Font Awesome](https://fontawesome.com) font is
licensed under the [SIL Open Font License](http://scripts.sil.org/OFL).
* [Font Awesome](https://fontawesome.com) CSS files are
licensed under the
[MIT License](http://opensource.org/licenses/mit-license.html).
* The remainder of the font-awesome-rails project is licensed under the
[MIT License](http://opensource.org/licenses/mit-license.html).