Class: Primer::Alpha::TreeView::IconPair

Inherits:
Component
  • Object
show all
Defined in:
app/components/primer/alpha/tree_view/icon_pair.rb

Overview

A pair of icons for a ‘TreeView` sub-tree that displays distinct icons when the sub-tree is expanded and collapsed.

This component is part of the <%= link_to_component(Primer::Alpha::TreeView) %> component and should not be used directly.

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

Primer::AttributesHelper::PLURAL_ARIA_ATTRIBUTES, Primer::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 Primer::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(expanded: false, **system_arguments) ⇒ IconPair

Returns a new instance of IconPair.

Parameters:

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

    If true, the expanded icon is shown and the collapsed icon is hidden, etc.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



34
35
36
37
38
 
# File 'app/components/primer/alpha/tree_view/icon_pair.rb', line 34

def initialize(expanded: false, **system_arguments)
  @expanded = expanded
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:tag] = :"tree-view-icon-pair"
end

Instance Attribute Details

#expanded ⇒ Boolean (readonly) Also known as: expanded?

Whether or not this icon is expanded.

Returns:

  • (Boolean) 


29
30
31
 
# File 'app/components/primer/alpha/tree_view/icon_pair.rb', line 29

def expanded
  @expanded
end