Class: Primer::Beta::BaseButton

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

Overview

Use ‘BaseButton` to render an unstyled `<button>` tag that can be customized.

Direct Known Subclasses

ClipboardCopyBaseButton

Constant Summary collapse

DEFAULT_TAG = 
:button
TAG_OPTIONS = 
[DEFAULT_TAG, :a, :summary, :"clipboard-copy"].freeze
DEFAULT_TYPE = 
:button
TYPE_OPTIONS = 
[DEFAULT_TYPE, :reset, :submit].freeze

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 Attribute Summary collapse

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, #merge_aria, #merge_data, #merge_prefixed_attribute_hashes

Constructor Details

#initialize(tag: DEFAULT_TAG, type: DEFAULT_TYPE, block: false, disabled: false, inactive: false, **system_arguments) ⇒ BaseButton

Returns a new instance of BaseButton.

Parameters:

  • tag (Symbol) (defaults to: DEFAULT_TAG) —

    <%= one_of(Primer::Beta::BaseButton::TAG_OPTIONS) %>

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

    <%= one_of(Primer::Beta::BaseButton::TYPE_OPTIONS) %>

  • block (Boolean) (defaults to: false) —

    Whether button is full-width with ‘display: block`.

  • disabled (Boolean) (defaults to: false) —

    Whether or not the button is disabled. If true, this option forces ‘tag:` to `:button`.

  • inactive (Boolean) (defaults to: false) —

    Whether the button looks visually disabled, but can still accept all the same interactions as an enabled button.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'app/components/primer/beta/base_button.rb', line 24

def initialize(
  tag: DEFAULT_TAG,
  type: DEFAULT_TYPE,
  block: false,
  disabled: false,
  inactive: false,
  **system_arguments
)
  @system_arguments = system_arguments
  @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, DEFAULT_TAG)

  @system_arguments[:type] = fetch_or_fallback(TYPE_OPTIONS, type, DEFAULT_TYPE) if @system_arguments[:tag] == :button

  @system_arguments[:classes] = class_names(
    system_arguments[:classes],
    "btn-block" => block
  )

  @system_arguments[:"aria-disabled"] = true if inactive

  @disabled = disabled
  return unless @disabled

  @system_arguments[:tag] = :button
  @system_arguments[:disabled] = ""
end

Instance Attribute Details

#disabled ⇒ Object (readonly) Also known as: disabled?

Returns the value of attribute disabled.



15
16
17
 
# File 'app/components/primer/beta/base_button.rb', line 15

def disabled
  @disabled
end

Instance Method Details

#call ⇒ Object 



51
52
53
 
# File 'app/components/primer/beta/base_button.rb', line 51

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