No commit activity in last 3 years
No release in over 3 years
A library to generate Bootstrap HTML for Rails.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 0.0.16
>= 4.0.0
 Project Readme

BootstrapBuilders

The following examples are shown in HAML syntax but the project can of course be used with ERB and Slim as well.

Install

Add to your Gemfile and bundle:

gem "bootstrap_builders"

Then add to your ApplicationHelper module:

module ApplicationHelper
  include BootstrapBuilders::ApplicationHelper
end

Then add to your application.js:

//= require bootstrap_builders

Then add to your application.scss:

@import "bootstrap_builders";

Or if you haven't loaded Bootstrap through SCSS:

@import "bootstrap_builders/bootstrap-variables";
@import "bootstrap_builders";

Usage

Date picker input for SimpleForm

<%= f.input :activation_at, as: :bb_date_picker %>
<%= f.input :something_at, as: :bb_date_time_picker %>

You might encounter some trouble with specs. Use the helpers:

config.include BootstrapBuilders::CapybaraSpecHelpers

And in the test:

set_bb_date_input ".subscription_start_date", 2.days.from_now.to_date

Panel

  1. Panel in all its glory with elements and classes
  2. Controls if :right argument is given
  3. Table if :table argument is given
<%= bb_panel "Title of panel", controls: button_content do %>
  Content of panel
<% end %>
<%= bb_panel "Title of panel", controls: button_content do |panel| %>
  <% panel.controls << bb_btn("#", "Another button", :mini) %>
  Content of panel
<% end %>

Panel with a table

<%= bb_panel "Title of panel", table: true do %>
  <tbody>
    <tr>
      <td>Test</td>
    </tr>
  </tbody>
<% end %>

You can add custom classes like this:

<%= bb_panel "Title of panel", table: {bs_classes: [:striped]} do %>
  <tbody>
    <tr>
      <td>Test</td>
    </tr>
  </tbody>
<% end %>

You can make the panel collapsed with the title functioning as the open toggle like this:

<%= bb_panel "Title", :collapsable, :collapsed do %>
 Ā Content
<% end %>

Table

  1. Adds Bootstrap classes: "table", "table-hover", "table-striped"
<%= bb_table do %>
  <tbody>
    <tr>
      <td>Test</td>
    </tr>
  </tbody>
<% end %>
  1. A table showing a models attributes:
<%= bb_table do %>
  <tbody>
    <%= bb_attribute_rows @model, [:id, :created_at, :updated_at] %>
  </tbody>
<% end %>

You can change the default classes like this:

BootstrapBuilders.configuration.default_table_classes = [:striped, :hover]

The classes "bb-table" and "table" are always added.

Buttons

  1. Adds icons automatically
  2. Adds labels automatically
  3. Doesn't show button if CanCan doesn't allow it
<%= bb_new_btn url: [:admin, User] %>
<%= bb_edit_btn url: [:admin, user], :mini %>
<%= bb_destroy_btn url: [:admin, user], label: false %>
<%= bb_btn "/url", "My label", :block, :lg, :confirm, :disabled %>

Button drop downs

<%= bb_btn_drop_down label: t("actions") do |drop_down| %>
  <% drop_down.option [:new, :something], t(".new"), icon: "plus" %>
<% end %>

Responsive mixins

Use responsive mixins to only apply certain CSS rules on specific sizes, below or above.

.some-class {
  @include bb-when-sm-down() {
    width: 100px;
  }

  @include bb-when-md-up() {
    width: 200px;
  }
}

@include bb-when-xs() { ... }
@include bb-when-sm() { ... }
@include bb-when-sm-up() { ... }
@include bb-when-sm-down() { ... }
@include bb-when-md() { ... }
@include bb-when-md-up() { ... }
@include bb-when-md-down() { ... }
@include bb-when-lg() { ... }

Responsive classes

.text-align-left-xs
.text-align-right-sm-up
.text-align-center-md-down

And so on...

Tabs

<%= bb_tabs do |tabs| %>
  <%= tabs.tab "Title" do %>
    Content of tab
  <% end %>
<% end %>
<%= bb_tabs :pills, :stacked do |tabs| %>
  <%= tabs.tab "Title", "id-of-content-container" do %>
    Content of tab
  <% end %>
  <%= tabs.tab "Load on demand", ajax_url: some_path %>
<% end %>

Pre-select a tab by using the query parameter called "bb_selected_tab" like so: "?bb_selected_tab=id-of-content-container". This will also work with ajax tabs.

Flash

<%= bb_flash %>

Contributing to bootstrap_builders

  • Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
  • Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
  • Fork the project.
  • Start a feature/bugfix branch.
  • Commit and push until you are happy with your contribution.
  • Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
  • Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

Copyright

Copyright (c) 2016 kaspernj. See LICENSE.txt for further details.