Class: Primer::CloseButton

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

Overview

Use ‘CloseButton` to render an `×` without default button styles.

[0]: primer.style/view-components/system-arguments#html-attributes

Constant Summary collapse

DEFAULT_TYPE = 
:button
TYPE_OPTIONS = 
[DEFAULT_TYPE, :submit].freeze

Constants inherited from Component

Primer::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

Instance Method Summary collapse

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

Constructor Details

#initialize(type: DEFAULT_TYPE, **system_arguments) ⇒ CloseButton

Returns a new instance of CloseButton.

Examples:

Default

<%= render(Primer::CloseButton.new) %>

Parameters:

  • type (Symbol) (defaults to: DEFAULT_TYPE) —

    <%= one_of(Primer::CloseButton::TYPE_OPTIONS) %>

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



21
22
23
24
25
26
27
28
29
30
31
 
# File 'app/components/primer/close_button.rb', line 21

def initialize(type: DEFAULT_TYPE, **system_arguments)
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:tag] = :button
  @system_arguments[:block] = false
  @system_arguments[:type] = fetch_or_fallback(TYPE_OPTIONS, type, DEFAULT_TYPE)
  @system_arguments[:classes] = class_names(
    "close-button",
    system_arguments[:classes]
  )
  @system_arguments[:"aria-label"] ||= "Close"
end

Instance Method Details

#call ⇒ Object 



33
34
35
36
37
 
# File 'app/components/primer/close_button.rb', line 33

def call
  render(Primer::BaseButton.new(**@system_arguments)) do
    render(Primer::OcticonComponent.new("x"))
  end
end