bootstrap-rails-helpers

Bootstrap is a toolkit from Twitter designed to kickstart development of webapps and sites. It includes base CSS and HTML for typography, forms, buttons, tables, grids, navigation, and more.

bootstrap-rails-helpers is a lightweight gem that includes many helper methods used in many Rails applications.

Installation

As most of the heleprs are based off it, if you are already using twitter-bootstrap-rails (https://github.com/seyhunak/twitter-bootstrap-rails), then you already have most of these helpers in place.

If you haven't already installed Twitter Bootstrap, you will need to add it to your project.

You can install Bootstrap using one of the following gems:

• bootstrap-sass (https://github.com/thomas-mcdonald/bootstrap-sass)
• sass-twitter-bootstrap (https://github.com/jlong/sass-twitter-bootstrap)
• less-rails-bootstrap (https://github.com/metaskills/less-rails-bootstrap)

Or you could add it directly to your assets pipeline by downloading Twitter Bootstrap directly.

Once you have Twitter Bootstrap available you just need to add the following to your Gemfile.

gem 'bootstrap-rails-helpers'

Once that's in place, run bundle install and you're ready.

Helpers

Flash Messages

Rails provides a standard convention called flash to display alerts (including error messages) and other notices.

Add the following tag to <%= bootstrap_flash %> to your layout in order for each message to be displayed as an Alerts.

Rails uses :notice and :alert as its defailt flash message keys. The bootstrap_flash tag converts these statuses to .alert-success and .alert-error.

You can add individual alert boxes using the following tag:

<%= alert_message "Hello Bootstrap", :alert_type => :success %>

Breadcrumbs

Add the breadcrumbs tag <%= render_breadcrumbs %> to your layout to add a series of breadcrumbs to your views.

From within your views, use the add_breadcrumb tag to populate the breadcrumb list.

# examples/index.html.erb
<%- add_breadcrumb :index, examples_url -%>

# examples/show.html.erb
<%- add_breadcrumb :index, examples_url -%>
<%- add_breadcrumb @example.title, example_url(@example) -%>

# examples/new.html.erb
<%- add_breadcrumb :index, examples_url -%>
<%- add_breadcrumb :new, new_example_url -%>

# examples/edit.html.erb
<%- add_breadcrumb :index, examples_url -%>
<%- add_breadcrumb @example.title, example_url(@example) -%>
<%- add_breadcrumb :edit, edit_example_url(@example) -%>

Ruby symbols used for labes fall back to I18n translations based off the current controller, Translations fall back to the defaults namespace if the exact translation path is not found.

en:
  breadcrumbs:
    defaults:
      home: 'Home'
      index: 'Index'
      edit: 'Edit'
      show: 'Show'
      new: 'New'

    examples:
      index: 'Examples'
      new: 'New Example'
      edit: 'Edit Example'

Breadcrumbs in Controllers

While I don't explicitly recommend it; it might be useful to add breadcrumbs directly from your Controllers. You can use the add_breacrumb tag by including BootstrapRailsHelpers::Breadcrumbs in your Controller, e.g.

class ExampleController < ApplicationController
  include BootstrapRailsHelpers::Breadcrumbs

  add_breadcrumb :index, :examples_url
end

Glyphs

You can easily use Icons by Glyphicons in your views by using the glyph tag.

<%= glyph(:share_alt) %>
# => <i class="icon-share-alt"></i>

You can also use the white icon variation:

glyph(:lock, :white)
# => <i class="icon-lock icon-white"></i>

License

Copyright (c) 2013 Ben Morrall

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.