Class: Primer::IconButton

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

Overview

Use ‘IconButton` to render Icon-only buttons without the default button styles.

‘IconButton` will always render with a tooltip unless the tag is `:summary`.

Constant Summary collapse

DEFAULT_SCHEME = 
:default
SCHEME_MAPPINGS = 
{
  DEFAULT_SCHEME => "",
  :danger => "btn-octicon-danger"
}.freeze
SCHEME_OPTIONS = 
SCHEME_MAPPINGS.keys

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

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(icon:, scheme: DEFAULT_SCHEME, box: false, tooltip_direction: Primer::Alpha::Tooltip::DIRECTION_DEFAULT, **system_arguments) ⇒ IconButton 



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
64
65
66
67
68
69
70
 
# File 'app/components/primer/icon_button.rb', line 33

def initialize(icon:, scheme: DEFAULT_SCHEME, box: false, tooltip_direction: Primer::Alpha::Tooltip::DIRECTION_DEFAULT, **system_arguments)
  @icon = icon

  @system_arguments = system_arguments

  @system_arguments[:id] ||= self.class.generate_id

  @system_arguments[:classes] = class_names(
    "btn-octicon",
    SCHEME_MAPPINGS[fetch_or_fallback(SCHEME_OPTIONS, scheme, DEFAULT_SCHEME)],
    system_arguments[:classes],
    "Box-btn-octicon" => box
  )

  validate_aria_label

  @aria_label = aria("label", @system_arguments)
  @aria_description = aria("description", @system_arguments)

  @tooltip_arguments = {
    for_id: @system_arguments[:id],
    direction: tooltip_direction
  }

  # If we have both an `aria-label` and a `aria-description`, we create a `Tooltip` with the description type and keep the `aria-label` in the button.
  # Otherwise, the `aria-label` is used as the tooltip text, which is the `aria-labelled-by` of the button, so we don't set it in the button.
  if @aria_label.present? && @aria_description.present?
    @system_arguments.delete(:"aria-description")
    @system_arguments[:aria].delete(:description) if @system_arguments.include?(:aria)
    @tooltip_arguments[:text] = @aria_description
    @tooltip_arguments[:type] = :description
  else
    @system_arguments.delete(:"aria-label")
    @system_arguments[:aria].delete(:label) if @system_arguments.include?(:aria)
    @tooltip_arguments[:text] = @aria_label
    @tooltip_arguments[:type] = :label
  end
end