Module: Booties::TooltipHelper

Defined in:
app/helpers/booties/tooltip_helper.rb

Instance Method Summary collapse

Instance Method Details

#tooltip(title:, placement: nil, **options, &block) ⇒ Object

Wraps the content provided by block with a Bootstrap tooltip. The text of the tooltip is passed in through the required title parameter. The optional placement parameter can be used to control alignment of the tooltip. Valid placements are :top, :bottom, :left, and :right. Additional paramters given in options are passed through to #content_tag to be placed on the resulting tag.

A caveat: Bootstrap tooltips are opt-in. You must initialize them yourself. One way to do this is to include the following Javascript snippet on the page:

$(function() { $('[data-toggle="tooltip"]').tooltip() }

Examples:

<%= tooltip title: 'This is a tooltip' do %>
  This has a tooltip.
<% end %>

<span data-toggle="tooltip" title="This is a tooltip">This has a tooltip.</span>

<%= tooltip title: 'This is a tooltip', placement: :bottom %>
  This has a tooltip.
<% end %>

<span data-toggle="tooltip" data-placement="bottom" title="This is a tooltip">This has a tooltip.</span>

<%= tooltip title: 'This is a tooltip', class: 'tooltip' %>
  This has a tooltip.
<% end %>

<span data-toggle="tooltip" title="This is a tooltip" class="tooltip">This has a tooltip.</span>



36
37
38
39
40
41
42
43
44
45
46
 
# File 'app/helpers/booties/tooltip_helper.rb', line 36

def tooltip(title:, placement: nil, **options, &block)
  unless [nil, :top, :bottom, :right, :left].include? placement
    raise ArgumentError, "invalid placement: #{placement.inspect}," \
      ' valid placements are: :top, :bottom, :right, :left'
  end

  data = { toggle: 'tooltip' }
  data[:placement] = placement if placement

  content_tag :span, data: data, title: title, **options, &block
end