Rails Bootstrap Helpers

Rails Bootstrap Helpers is a plugin for Ruby on Rails that adds view helpers for Bootstrap.

Installation

Add it to your Gemfile:

gem "rails-bootstrap-helpers"

Manually include the necessary stylesheets and JavaScript files from Bootstrap.

Although it has no direct dependencies on other gems than Rails, it is necessary to include Bootstrap in some way or another to make this gem useful. bootstrap-sass is recommended.

JavaScript

Some of the helpers uses features of Bootstrap that requires JavaScript to be initialized. You need to manually do this initialization. The following helpers uses JavaScript that needs manually initialization:

• Any helper with the :tooltip option
• bs_popover_button

For which JavaScript file to include, follow the Bootstrap documentation.

Usage

Common

icon

<%= icon :edit %> # renders an icon with the icon-edit icon
<%= icon :edit, invert: true %> # inverts the color of the icon, making it white

Bootstrap documentation

Alerts

bs_alert

<%= bs_alert "foo" %> # standard alert box
<%= bs_alert "foo", block: true %> # alert box with block style
<%= bs_alert "foo", dismiss_button: true %> # alert box with a dismiss button

Bootstrap documentation

Buttons

bs_button_to

<%= bs_button_to "google", "http://www.google.se" %>
<%= bs_button_to "google", "http://www.google.se", style: "success" %>
<%= bs_button_to "google", "http://www.google.se", disabled: true %>
<%= bs_button_to "google", "http://www.google.se", icon: "edit" %>
<%= bs_button_to "google", "http://www.google.se", icon_position: "left" %>
<%= bs_button_to "google", "http://www.google.se", icon_invert: "left" %>

The bs_button_to helper renders an a tag, styled as a Bootstrap button. It's basically a wrapper around the link_to helper. In addition all the standard arguments and options that link_to accepts it also accepts the above options.

bs_inline_button_to

<%= bs_inline_button_to "http://www.google.se", :edit %>

The bs_inline_button_to helper renders an a tag, styled as a inline Bootstrap button. That is, a button with the an icon (no text) and the size "mini". Except from that it accepts all options as the bs_button_to does.

bs_popover_button

<%= bs_popover_button "foo", "bar"
<%= bs_popover_button "foo", "bar", placement: "right" %>
<%= bs_popover_button "foo" do %>
  <%= link_to "Google", "http://www.google.se" %>
<% end %>

Renders a Bootstrap button that when clicked opens a popover. The content of the popover can either be supplied as the second argument or as a block.

Note: this helper requires JavaScript to be manually initialized. Add the following code to your JavaScript file:

$("[data-toggle=popover]").popover(html: true)
// The "html" option tells the plugin to not escape HTML. Useful when rendering
// the popover content using a block.
```

[Bootstrap documentation](http://twitter.github.io/bootstrap/base-css.html#buttons)

### <a id="forms"></a>Forms

#### <a id="bs_button_tag"></a> bs\_button\_tag

```erb
<%= bs_button_to "google", :submit %>
```

Renders an `button` tag styled as a Bootstrap button. First argument is the text
to be rendered on the button, the other is what type of button (that is, the HTML
attribute `type`). Accepts all the options as [bs\_button\_to](#bs_button_to) does.

[Bootstrap documentation](http://twitter.github.io/bootstrap/base-css.html#buttons)

### <a id="labels"></a>Labels

#### <a id="bs_label"></a>bs\_label

```erb
<%= bs_label "foo" # standard label%>
<%= bs_label "foo", style: "success" # styled label %>
```

### <a id="tooltips"></a>Tooltips

```erb
<%= bs_label "foo", tooltip: "bar" %>
```

Basically any helper accepts the `:tooltip` option. This will add a Bootstrap
tooltip to the rendered component.

**Note:** this option requires JavaScript to be manually initialized. Add the
following code to your JavaScript file:

````javascript
$("[data-toggle=tooltip]").tooltip()
```

[Bootstrap documentation](http://twitter.github.io/bootstrap/components.html#labels-badges)

## Tests

Run the tests using RSpec

    $ bundle install
    $ bundle exec rspec

## License

Rails Bootstrap Helpers is licensed under [The MIT license](http://opensource.org/licenses/MIT)