module Bootstrap3Helper

This helper module includes UI helpers that will help generate common Bootstrap components.

@root

Constants

VERSION

Public Instance Methods

accordion_group_helper(*args, &block) click to toggle source

Easily build a bootstrap accordion group component.

@note All the element ids and data attributes needed to make the javascript

function, are all synced up in the AccordionGroup and Accordion classes.
You don't need to worry about them.

@example Bootstrap Accordion Group Component:

<%= accordion_group_helper do |group| %>
  <% group.accordion class: 'primary' do |accordion| %>
      <%= accordion.header { "accordion 1" } %>
      <%= accordion.body do %>
          <p>This is accordion 1</p>
      <% end %>
  <% end %>
  <% group.accordion class: 'info' do |accordion| %>
      <%= accordion.header { "accordion 2" } %>
      <%= accordion.body do %>
          <p>This is accordion 2</p>
      <% end %>
  <% end %>
  <% group.accordion class: 'danger' do |accordion| %>
      <%= accordion.header { "accordion 3" } %>
      <%= accordion.body do %>
          <p>This is accordion 3</p>
      <% end %>
  <% end %>
<% end %>

@param [Symbol|String|Hash|NilClass] args @yieldparam [AccordionGroup] group @return [String]

# File lib/bootstrap3_helper.rb, line 112
def accordion_group_helper(*args, &block)
  AccordionGroup.new(self, *args, &block)
end
accordion_helper(*args, &block) click to toggle source

Easily build a bootstrap accordion component

@example Bootstrap Panel Component:

<%= accordion_helper class: 'primary' do |accordion| %>
    <%= accordion.header do %>
        <span class="something">This is the heading....</span>
    <% end %>
    <%= accordion.body do %>
        <p>This is the body of the accordion....</p>
    <% end %>
<% end %>

@param [Symbol|String|Hash|NilClass] args @yieldparam [Accordion] accordion @return [String]

# File lib/bootstrap3_helper.rb, line 132
def accordion_helper(*args, &block)
  Accordion.new(self, *args, &block)
end
alert_helper(*args, &block) click to toggle source

Creates an Alert component.

@example Bootstrap Alert Component:

<%= alert_helper :danger, dismissble: true do %>
  Something went wrong with your model data...
<% end %>

@param [Symbol|String|Hash|NilClass] args @yieldreturn [String] @return [String]

# File lib/bootstrap3_helper.rb, line 52
def alert_helper(*args, &block)
  Alert.new(self, *args, &block)
end
callout_helper(*args, &block) click to toggle source

Creates an Callout component.

@example Bootstrap Callout Component:

<%= callout_helper :danger %>
  Some information that needs your attention...
<% end %>

@param [Symbol|String|Hash|NilClass] args @yieldreturn [String] @return [String]

# File lib/bootstrap3_helper.rb, line 67
def callout_helper(*args, &block)
  Callout.new(self, *args, &block)
end
host_is_dev_pc?() click to toggle source

Just a easy way of checking if the environment is a devbox or a server.

@return [Boolean]

# File lib/bootstrap3_helper.rb, line 76
def host_is_dev_pc?
  Rails.root.to_s.include?('home')
end
icon_helper(name) click to toggle source

Allows you to rapidly build bootstrap glyphs.

@note Only supply the last part of the glyph makrup.

@example Bootstrap Glyphicon Component:

<%= icon_helper('pencil') %>

@param [String|Symbol] name

# File lib/bootstrap3_helper.rb, line 145
def icon_helper(name)
  content_tag :span, '', class: "glyphicon glyphicon-#{name}"
end
panel_helper(*args, &block) click to toggle source

Allows you to rapidly build Panel components.

@example Bootstrap Panel Component:

<%= panel_helper :primary do |p| %>
  <%= p.header { "Some Title" }
  <%= p.body class: 'custom-class', id: 'custom-id' do %>
    //HTML or Ruby code here...
  <% end %>
  <%= p.footer do %>
    //HTML or Ruby
  <% end %>
<% end %>

@param [Symbol|String|Hash|NilClass] args @yieldparam [Panel] panel @return [String]

# File lib/bootstrap3_helper.rb, line 37
def panel_helper(*args, &block)
  Panel.new(self, *args, &block)
end
tabs_helper(args = {}, &block) click to toggle source

Used to rapidly build Tabs.

@note On menu items - you can pass in either symbol or string for the link. If

you pass in a block, it will use the block for the title of the li.  If no
block is present, then it will titleize the symbol or string.
Tabs::Menu will respond to <code>item</code> and <code>dropdown</code>
Each method will yield the corresponding component, either a Tabs::Menu
or a Tabs::Dropdown.

@example Bootstrap Tabs Component:

<%= tabs_helper type: :pills do |menu, content| %>
  <%= menu.item(:testing1, class: 'active') { ' Testing 1' } %>
  <%= menu.item :testing2 %>
  <%= menu.item(:testing3) { ' Testing 3' } %>
  <%= menu.dropdown 'Testing Dropdown' do |dropdown| %>
      <%= dropdown.item(:testing5 ) { 'Testing 5' } %>
      <%= dropdown.item(:testing6 ) { 'Testing 6' } %>
      <%= dropdown.item(:testing7 ) { 'Testing 7' } %>
  <% end %>

  <%= content.item :testing1, class: 'active' do %>
      Testing 1 content
  <% end %>
  <%= content.item :testing2 do %>
      Testing 2 content
  <% end %>
  <%= content.item :testing3 do %>
      Testing 3 content
  <% end %>
  <%= content.item :testing5 do %>
      Testing 5 content
  <% end %>
  <%= content.item :testing6 do %>
      Testing 6 content
  <% end %>
  <%= content.item :testing7 do %>
      Testing 7 content
  <% end %>
<% end %>

@param [Symbol|String|Hash|NilClass] args @yieldparam [Tabs] tabs @return [String]

# File lib/bootstrap3_helper.rb, line 194
def tabs_helper(args = {}, &block)
  Tabs.new(self, args, &block)
end