Module: EffectiveBootstrapHelper

Defined in:
app/helpers/effective_bootstrap_helper.rb

Overview

Boostrap4 Helpers

Constant Summary collapse 

{class: "btn dropdown-toggle dropdown-toggle-split btn-sm btn-outline-primary", type: 'button', 'data-toggle': 'dropdown', 'aria-haspopup': true, 'aria-expanded': false}

{class: "btn dropdown-toggle btn-sm btn-outline-primary", type: 'button', 'data-toggle': 'dropdown', 'aria-haspopup': true, 'aria-expanded': false}

{class: 'btn-group'}

{class: 'btn-group dropleft', role: 'group'}

{class: 'dropdown-menu'}

{class: 'dropdown-menu dropdown-menu-right'}

'btn-sm btn-outline-primary'

"<span class='sr-only'>Toggle Dropdown</span>".html_safe

Instance Method Summary collapse

Instance Method Details

#accordion(options = nil, &block) ⇒ Object

This is a special variant of collapse

accordion do

= collapse('Add thing...') do
  p Something to add



10
11
12
13
14
15
16
17
18
19
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 10

def accordion(options = nil, &block)
  (options ||= {})[:class] = "accordion #{options.delete(:class)}".strip

  id = "accordion-#{''.object_id}"

  @_accordion_active = id
  content = content_tag(:div, capture(&block), options.merge(id: id))
  @_accordion_active = nil
  content
end

#bootstrap_paginate(collection, per_page:, url: nil, window: 2, collection_count: nil, render_single_page: false) ⇒ Object Also known as: paginate

limit(per_page).offset(offset) }

Add this to your controller: Add this to your view %nav= paginate(@posts, per_page: 10)



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 268

def bootstrap_paginate(collection, per_page:, url: nil, window: 2, collection_count: nil, render_single_page: false)
  raise 'expected an ActiveRecord::Relation' unless collection.respond_to?(:limit) && collection.respond_to?(:offset)

  collection_count ||= collection.limit(nil).offset(nil).count # You can pass the total count, or not.

  page = (params[:page] || 1).to_i
  last = (collection_count.to_f / per_page).ceil

  return unless (last > 1 || render_single_page) # If there's only 1 page, don't render a pagination at all.

  # Build URL
  uri = URI(url || request.fullpath)
  params = Rack::Utils.parse_nested_query(uri.query)
  url = uri.path + '?'

  # Pagination Tags
  prev_tag = content_tag(:li, class: ['page-item', ('disabled' if page <= 1)].compact.join(' ')) do
    link_to(content_tag(:span, 'Previous'.html_safe), (page <= 1 ? '#' : url + params.merge('page' => page - 1).to_query),
      class: 'page-link', 'aria-label': 'Previous', title: 'Previous', 'aria-disabled': ('true' if page <= 1), 'tabindex': ('-1' if page <= 1)
    )
  end

  next_tag = content_tag(:li, class: ['page-item', ('disabled' if page >= last)].compact.join(' ')) do
    link_to(content_tag(:span, 'Next'.html_safe), (page >= last ? '#' : url + params.merge('page' => page + 1).to_query),
      class: 'page-link', 'aria-label': 'Next', title: 'Next', 'aria-disabled': ('true' if page >= last), 'tabindex': ('-1' if page >= last)
    )
  end

  dots_tag = content_tag(:li, class: 'page-item disabled') do
    link_to('...', '#', class: 'page-link', 'aria-label': '...', 'aria-disabled': true, tabindex: '-1')
  end

  # Calculate Windows
  length = 1 + (window * 2)
  left = 1.upto(last).to_a.first(length)
  right = 1.upto(last).to_a.last(length)
  center = []
  max = length + 2

  if last <= max
    left = left - right
    right = right - left
  elsif left.include?(page + 1)
    right = [last]
    left = left - right
  elsif right.include?(page - 1)
    left = [1]
    right = right - left
  else
    left = [1]
    right = [last]
    center = (page - window + 1).upto(page + window - 1).to_a
  end

  # Render the pagination
  content_tag(:ul, class: 'pagination') do
    [
      prev_tag,
      left.map { |index| bootstrap_paginate_tag(index, page, url, params) },
      (dots_tag if last > max && left == [1]),
      center.map { |index| bootstrap_paginate_tag(index, page, url, params) },
      (dots_tag if last > max && right == [last]),
      right.map { |index| bootstrap_paginate_tag(index, page, url, params) },
      next_tag
    ].flatten.join.html_safe
  end
end

#bootstrap_paginate_tag(index, page, url, params) ⇒ Object 



336
337
338
339
340
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 336

def bootstrap_paginate_tag(index, page, url, params)
  content_tag(:li, class: ['page-item', ('active' if index == page)].compact.join(' '), title: "Page #{index}") do
    link_to(index, (url + params.merge('page' => index).to_query), class: 'page-link')
  end
end

#collapse(label, opts = {}, &block) ⇒ Object

collapse(items.length, class: ‘btn btn-primary’, class: ‘mt-2’) do

items.map { |item| content_tag(:div, item.to_s) }.join.html_safe

end



32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 32

def collapse(label, opts = {}, &block)
  raise 'expected a block' unless block_given?

  id = "collapse-#{String.new.object_id}"
  show = (opts.delete(:show) == true)

  link_opts = { 'data-toggle': 'collapse', role: 'button', href: "##{id}", 'aria-controls': "##{id}", 'aria-expanded': show }

  link_opts[:class] = opts.delete(:link_class) || 'btn btn-link'
  div_class = opts.delete(:div_class)
  card_class = opts.delete(:card_class) || 'card card-body my-2'

  if @_accordion_active
    # Accordion collapse
    content_tag(:div, class: "card mb-0") do
      content_tag(:div, class: "card-header") do
        content_tag(:h2, class: "mb-0") do
          content_tag(:button, label, link_opts.merge(class: "btn btn-link"))
        end
      end +
      content_tag(:div, id: id, class: ['collapse', div_class, ('show' if show)].compact.join(' '), "data-parent": "##{@_accordion_active}") do
        content_tag(:div, capture(&block), class: "card-body")
      end
    end
  else
    # Normal collapse
    content_tag(:a, label, link_opts) +
    content_tag(:div, id: id, class: ['collapse', div_class, ('show' if show)].compact.join(' ')) do
      content_tag(:div, capture(&block), class: card_class)
    end
  end
end

#dots(options = nil, &block) ⇒ Object

This is a special variant of dropdown dots do

= dropdown_link_to 'Edit', edit_path(thing)



141
142
143
144
145
146
147
148
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 141

def dots(options = nil, &block)
  (options ||= {})[:class] = "dropdown dropdown-dots #{options.delete(:class)}".strip

  content_tag(:div, options) do
    content_tag(:button, class: "btn btn-dots dropdown-toggle #{options.delete(:button_class)}", 'aria-expanded': true, 'aria-haspopup': true, 'data-toggle': 'dropdown', type: 'button') do
    end + content_tag(:div, capture(&block), class: 'dropdown-menu')
  end
end

#dots_link_to(label, path, options = {}) ⇒ Object 



150
151
152
153
154
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 150

def dots_link_to(label, path, options = {})
  options[:class] = [options[:class], 'dropdown-item'].compact.join(' ')

  concat link_to(label, path, options)
end

#dropdown(variation: nil, split: true, btn_class: nil, btn_content: nil, right: false, &block) ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 89

def dropdown(variation: nil, split: true, btn_class: nil, btn_content: nil, right: false, &block)
  raise 'expected a block' unless block_given?

  btn_class ||= DROPDOWN_BTN_CLASS

  # Process all dropdown_link_tos
  @_dropdown_link_tos = []
  @_dropdown_split = split
  @_dropdown_button_class = btn_class
  yield

  return @_dropdown_link_tos.first if @_dropdown_link_tos.length <= 1

  # Build tags
  first = @_dropdown_link_tos.first

  button_opts = (split ? DROPDOWN_SPLIT_OPTS : DROPDOWN_UNSPLIT_OPTS)

  if btn_class != DROPDOWN_BTN_CLASS
    button_opts[:class] = button_opts[:class].sub(DROPDOWN_BTN_CLASS, btn_class)
  end

  button = content_tag(:button, button_opts) do
    btn_content || DROPDOWN_TOGGLE_DROPDOWN
  end

  menu_opts = (right ? DROPDOWN_MENU_RIGHT_OPTS : DROPDOWN_MENU_OPTS)

  menu = if split
    content_tag(:div, @_dropdown_link_tos[1..-1].join.html_safe, menu_opts)
  else
    content_tag(:div, @_dropdown_link_tos.join.html_safe, menu_opts)
  end

  @_dropdown_link_tos = nil

  if split && variation == :dropleft
    content_tag(:div, DROPDOWN_DROPLEFT_GROUP_OPTS) do
      content_tag(:div, (button + menu), DROPDOWN_DROPLEFT_OPTS) + first.html_safe
    end
  elsif split
    content_tag(:div, class: 'btn-group') do
      content_tag(:div, (first + button + menu), class: "btn-group #{variation}", role: 'group')
    end
  else
    content_tag(:div, (button + menu), class: 'dropdown')
  end
end

#dropdown_divider(options = {}) ⇒ Object

Works with dots ao and dropdown do



177
178
179
180
181
182
183
184
185
186
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 177

def dropdown_divider(options = {})
  options[:class] = [options[:class], 'dropdown-divider'].compact.join(' ')

  unless @_dropdown_link_tos
    content_tag(:div, '', options)
  else
    @_dropdown_link_tos << content_tag(:div, '', options)
    nil
  end
end

#dropdown_link_to(label, path, options = {}) ⇒ Object

Works with dots do and dropdown do



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 157

def dropdown_link_to(label, path, options = {})
  btn_class = options.delete(:btn_class).presence || @_dropdown_button_class || 'btn-outline-primary'

  unless @_dropdown_link_tos
    options[:class] = (options[:class] ? "dropdown-item #{options[:class]}" : 'dropdown-item')
    return link_to(label, path, options)
  end

  if @_dropdown_link_tos.length == 0 && @_dropdown_split
    options[:class] = (options[:class] ? "btn #{btn_class} #{options[:class]}" : "btn #{btn_class}")
  else
    options[:class] = (options[:class] ? "dropdown-item #{options[:class]}" : 'dropdown-item')
  end

  @_dropdown_link_tos << link_to(label, path, options)

  nil
end

#list_group(&block) ⇒ Object 



188
189
190
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 188

def list_group(&block)
  content_tag(:div, yield, class: 'list-group')
end

#list_group_link_to(label, path, opts = {}) ⇒ Object

List group

list_group_link_to

Automatically puts in the ‘active’ class based on request path



195
196
197
198
199
200
201
202
203
204
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 195

def list_group_link_to(label, path, opts = {})
  # Regular link item
  opts[:class] = if request.fullpath.include?(path)
    [opts[:class], 'list-group-item active'].compact.join(' ')
  else
    [opts[:class], 'list-group-item'].compact.join(' ')
  end

  link_to(label.to_s, path, opts)
end

#merge_class_key(hash, value) ⇒ Object 



396
397
398
399
400
401
402
403
404
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 396

def merge_class_key(hash, value)
  return { :class => value } unless hash.kind_of?(Hash)

  if hash[:class].present?
    hash.merge!(:class => "#{hash[:class]} #{value}")
  else
    hash.merge!(:class => value)
  end
end

#nav_divider ⇒ Object 



243
244
245
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 243

def nav_divider
  content_tag(:div, '', class: 'dropdown-divider')
end

#nav_dropdown(label, right: false, link_class: [], list_class: [], &block) ⇒ Object 



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 229

def nav_dropdown(label, right: false, link_class: [], list_class: [], &block)
  raise 'expected a block' unless block_given?

  id = "dropdown-#{''.object_id}"

  content_tag(:li, class: 'nav-item dropdown') do
    content_tag(:a, class: 'nav-link dropdown-toggle', href: '#', id: id, role: 'button', 'data-toggle': 'dropdown', 'aria-haspopup': true, 'aria-expanded': false) do
      label.html_safe
    end + content_tag(:div, class: (right ? 'dropdown-menu dropdown-menu-right' : 'dropdown-menu'), 'aria-labelledby': id) do
      @_nav_mode = :dropdown; yield; @_nav_mode = nil
    end
  end
end

#nav_link_to(label, path, opts = {}) ⇒ Object

%ul.navbar-nav

= nav_link_to 'Sign In', new_user_session_path
= nav_dropdown 'Settings' do
  = nav_link_to 'Account Settings', 
  = nav_divider
  = nav_link_to 'Sign In', new_user_session_path, method: :delete



215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 215

def nav_link_to(label, path, opts = {})
  if @_nav_mode == :dropdown  # We insert dropdown-items
    return link_to(label, path, merge_class_key(opts, 'dropdown-item'))
  end

  strict = opts.delete(:strict)
  active = (strict ? (request.fullpath == path) : request.fullpath.include?(path))

  # Regular nav link item
  content_tag(:li, class: (active ? 'nav-item active' : 'nav-item')) do
    link_to(label, path, merge_class_key(opts, 'nav-link'))
  end
end

#tab(label, options = {}, &block) ⇒ Object 



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 375

def tab(label, options = {}, &block)
  controls = options.delete(:controls) || label.to_s.parameterize.gsub('_', '-')
  controls = controls[1..-1] if controls[0] == '#'
  controls = "#{controls}-#{@_tab_unique}" if @_tab_unique

  active = (@_tab_active == :first || @_tab_active == label)

  @_tab_active = nil if @_tab_active == :first

  if @_tab_mode == :tablist # Inserting the label into the tablist top
    content_tag(:li, class: 'nav-item') do
      content_tag(:a, label, id: ('tab-' + controls), class: ['nav-link', ('active' if active)].compact.join(' '), href: '#' + controls, 'aria-controls': controls, 'aria-selected': active.to_s, 'data-toggle': 'tab', role: 'tab')
    end
  else # Inserting the content into the tab itself
    classes = ['tab-pane', 'fade', ('show active' if active), options[:class].presence].compact.join(' ')
    content_tag(:div, id: controls, class: classes, role: 'tabpanel', 'aria-labelledby': ('tab-' + controls)) do
      yield
    end
  end
end

#tabs(active: nil, unique: false, list: {}, content: {}, &block) ⇒ Object

If you pass active ‘label’ it will make that tab active. Otherwise first. Unique will make sure the tab html IDs are unique $(‘#tab-demographics’).tab(‘show’)



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'app/helpers/effective_bootstrap_helper.rb', line 358

def tabs(active: nil, unique: false, list: {}, content: {}, &block)
  raise 'expected a block' unless block_given?

  @_tab_mode = :tablist
  @_tab_active = (active || :first)
  @_tab_unique = ''.object_id if unique

  content_tag(:ul, {class: 'nav nav-tabs', role: 'tablist'}.merge(list)) do
    yield # Yield to tab the first time
  end +
  content_tag(:div, {class: 'tab-content'}.merge(content)) do
    @_tab_mode = :content
    @_tab_active = (active || :first)
    yield # Yield to tab the second time
  end
end