Class: Primer::Tooltip

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/tooltip.rb

Overview

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

Constant Summary collapse

DIRECTION_DEFAULT = 
:n
ALIGN_DEFAULT = 
:default
MULTILINE_DEFAULT = 
false
DELAY_DEFAULT = 
false
ALIGN_MAPPING = 
{
  ALIGN_DEFAULT => "",
  :left_1 => "tooltipped-align-left-1",
  :right_1 => "tooltipped-align-right-1",
  :left_2 => "tooltipped-align-left-2",
  :right_2 => "tooltipped-align-right-2"
}.freeze
DIRECTION_OPTIONS = 
[DIRECTION_DEFAULT] + %i[
  nw
  ne
  w
  e
  sw
  s
  se
]

Constants inherited from Component

Component::INVALID_ARIA_LABEL_TAGS

Constants included from Status::Dsl

Status::Dsl::STATUSES

Constants included from ViewHelper

ViewHelper::HELPERS

Constants included from TestSelectorHelper

Primer::TestSelectorHelper::TEST_SELECTOR_TAG

Constants included from FetchOrFallbackHelper

FetchOrFallbackHelper::InvalidValueError

Constants included from AttributesHelper

AttributesHelper::PLURAL_ARIA_ATTRIBUTES, AttributesHelper::PLURAL_DATA_ATTRIBUTES

Instance Method Summary collapse

Methods inherited from Component

deprecated?, generate_id

Methods included from JoinStyleArgumentsHelper

#join_style_arguments

Methods included from TestSelectorHelper

#add_test_selector

Methods included from FetchOrFallbackHelper

#fetch_or_fallback, #fetch_or_fallback_boolean, #silence_deprecations?

Methods included from ClassNameHelper

#class_names

Methods included from AttributesHelper

#aria, #data, #extract_data, #merge_aria, #merge_data, #merge_prefixed_attribute_hashes

Methods included from ExperimentalSlotHelpers

included

Methods included from ExperimentalRenderHelpers

included

Constructor Details

#initialize(label:, direction: DIRECTION_DEFAULT, align: ALIGN_DEFAULT, multiline: MULTILINE_DEFAULT, no_delay: DELAY_DEFAULT, **system_arguments) ⇒ Tooltip

Returns a new instance of Tooltip.

Parameters:

  • label (String) —

    the text to appear in the tooltip

  • direction (String) (defaults to: DIRECTION_DEFAULT) —

    Direction of the tooltip. <%= one_of(Primer::Tooltip::DIRECTION_OPTIONS) %>

  • align (String) (defaults to: ALIGN_DEFAULT) —

    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) %>

  • multiline (Boolean) (defaults to: MULTILINE_DEFAULT) —

    Use this when you have long content

  • no_delay (Boolean) (defaults to: DELAY_DEFAULT) —

    By default the tooltips have a slight delay before appearing. Set true to override this

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'app/components/primer/tooltip.rb', line 37

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

Instance Method Details

#call ⇒ Object 



60
61
62
 
# File 'app/components/primer/tooltip.rb', line 60

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