# Boostrap Icons Rails
[![Gem Version](https://badge.fury.io/rb/bootstrap_icons_rails.svg)](https://badge.fury.io/rb/bootstrap_icons_rails)
[![BI version](https://d25lcipzij17d.cloudfront.net/badge.svg?id=gh&type=6&v=1.2.0&x2=0)](https://github.com/NILID/bootstrap_icons_rails/blob/master/lib/bootstrap_icons_rails/version.rb)
[![Build Status](https://travis-ci.org/NILID/bootstrap_icons_rails.svg?branch=master)](https://travis-ci.org/NILID/bootstrap_icons_rails)
**bootstrap_icons_rails** provides the [Bootstrap Icons](https://icons.getbootstrap.com/) web fonts, stylesheets as a Rails engine for use with the asset pipeline.
Keep track of changes in [Changelog](https://github.com/NILID/bootstrap_icons_rails/blob/master/CHANGELOG.md).
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'bootstrap_icons_rails'
```
### Install as SVG with JS
In your `application.css`, include the css file:
```css
*= require bootstrap_icons
```
or if you prefer scss add this to your `application.scss` file:
```scss
@import 'bootstrap_icons.css'; //application.scss
```
If you're using `.sass` and having problem with loading, try to omit `.css` extenstion and import font as follows:
```scss
@import 'bootstrap_icons';
```
## Usage
Gem provides Bootstrap Icons through helper. In your views just call `bi_icon`.
### Basic usage
```ruby
bi_icon('alarm')
# =>
bi_icon('alarm', style: 'color: Tomato')
# =>
bi_icon('alarm', class: 'my-class', text: 'Alarm')
# =>
# => Alarm
bi_icon(:alarm, text: 'Alarm', right: true)
# => Alarm
# =>
```
## License
The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
[Bootstrap Icons License](https://github.com/twbs/icons/blob/main/LICENSE.md).
### Buy me a coffee
If you liked this gem, you can
.