class Primer::Tooltip

‘Tooltip` is a wrapper component that will apply a tooltip to the provided content.

def call 

def call
  render(Primer::BaseComponent.new(**@system_arguments)) { content }
end

def initialize(

Parameters:
  • system_arguments (Hash) -- <%= link_to_system_arguments_docs %>
  • no_delay (Boolean) -- By default the tooltips have a slight delay before appearing. Set true to override this
  • multiline (Boolean) -- Use this when you have long content
  • align (String) -- Align tooltips to the left or right of an element, combined with a `direction` to specify north or south. <%= one_of(Primer::Tooltip::ALIGN_MAPPING.keys) %>
  • direction (String) -- Direction of the tooltip. <%= one_of(Primer::Tooltip::DIRECTION_OPTIONS) %>
  • label (String) -- the text to appear in the tooltip 
def initialize(
  label:,
  direction: DIRECTION_DEFAULT,
  align: ALIGN_DEFAULT,
  multiline: MULTILINE_DEFAULT,
  no_delay: DELAY_DEFAULT,
  **system_arguments
)
  @system_arguments = system_arguments
  @system_arguments[:tag] ||= :span # rubocop:disable Primer/NoTagMemoize
  @system_arguments[:aria] = { label: label }
  @system_arguments[:skip_aria_label_check] = true
  @system_arguments[:classes] = class_names(
    @system_arguments[:classes],
    "tooltipped",
    "tooltipped-#{fetch_or_fallback(DIRECTION_OPTIONS, direction, DIRECTION_DEFAULT)}",
    ALIGN_MAPPING[fetch_or_fallback(ALIGN_MAPPING.keys, align, ALIGN_DEFAULT)],
    "tooltipped-no-delay" => fetch_or_fallback_boolean(no_delay, DELAY_DEFAULT),
    "tooltipped-multiline" => fetch_or_fallback_boolean(multiline, MULTILINE_DEFAULT)
  )
end