Class: Primer::Beta::ButtonGroup

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

Overview

Use ‘ButtonGroup` to render a series of buttons.

Defined Under Namespace

Classes: MenuButton

Constant Summary

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(scheme: Primer::Beta::Button::DEFAULT_SCHEME, size: Primer::Beta::Button::DEFAULT_SIZE, **system_arguments) ⇒ ButtonGroup

Returns a new instance of ButtonGroup.

Parameters:

  • scheme (Symbol) (defaults to: Primer::Beta::Button::DEFAULT_SCHEME) —

    DEPRECATED. <%= one_of(Primer::Beta::Button::SCHEME_OPTIONS) %>

  • size (Symbol) (defaults to: Primer::Beta::Button::DEFAULT_SIZE) —

    <%= one_of(Primer::Beta::Button::SIZE_OPTIONS) %>

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



72
73
74
75
76
77
78
79
80
81
82
 
# File 'app/components/primer/beta/button_group.rb', line 72

def initialize(scheme: Primer::Beta::Button::DEFAULT_SCHEME, size: Primer::Beta::Button::DEFAULT_SIZE, **system_arguments)
  @size = size
  @scheme = scheme
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:tag] = :div

  @system_arguments[:classes] = class_names(
    "ButtonGroup",
    system_arguments[:classes]
  )
end

Instance Method Details

#render? ⇒ Boolean

Returns:

  • (Boolean) 


84
85
86
 
# File 'app/components/primer/beta/button_group.rb', line 84

def render?
  buttons.any?
end

#with_button(icon: nil, **system_arguments) ⇒ Object

Adds a button.

Parameters:

  • icon (Symbol) (defaults to: nil) —

    If included, adds a <%= link_to_component(Primer::Beta::IconButton) %> with the given <%= link_to_octicons %>. Otherwise, a <%= link_to_component(Primer::Beta::Button) %> is added instead.

  • system_arguments (Hash) —

    The arguments accepted by <%= link_to_component(Primer::Beta::Button) %> or <%= link_to_component(Primer::Beta::IconButton) %>, depending on the value of the ‘icon:` argument.



5
6
 
# File 'app/components/primer/beta/button_group.rb', line 5

def with_button(icon: nil, **system_arguments)
end

#with_clipboard_copy_button(**system_arguments) ⇒ Object

Adds a <%= link_to_component(Primer::Beta::ClipboardCopyButton) %>.

Parameters:

  • system_arguments (Hash) —

    The arguments accepted by <%= link_to_component(Primer::Beta::ClipboardCopyButton) %>.



4
5
 
# File 'app/components/primer/beta/button_group.rb', line 4

def with_clipboard_copy_button(**system_arguments)
end

#with_menu_button(**system_arguments) ⇒ Object

Adds a button that activates a menu when clicked.

Parameters:

  • system_arguments (Hash) —

    The arguments accepted by <%= link_to_component(Primer::Beta::ButtonGroup::MenuButton) %>.



4
5
 
# File 'app/components/primer/beta/button_group.rb', line 4

def with_menu_button(**system_arguments)
end