Class: Primer::Beta::Details

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

Overview

Use ‘DetailsComponent` to reveal content after clicking a button.

Constant Summary collapse

BODY_TAG_DEFAULT = 
:div
BODY_TAG_OPTIONS = 
[:ul, :"details-menu", :"details-dialog", BODY_TAG_DEFAULT].freeze
NO_OVERLAY = 
:none
OVERLAY_MAPPINGS = 
{
  NO_OVERLAY => "",
  :default => "details-overlay",
  :dark => "details-overlay details-overlay-dark"
}.freeze
ARIA_LABEL_OPEN_DEFAULT = 
"Collapse"
ARIA_LABEL_CLOSED_DEFAULT = 
"Expand"

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

Methods included from ExperimentalSlotHelpers

included

Methods included from ExperimentalRenderHelpers

included

Constructor Details

#initialize(overlay: NO_OVERLAY, reset: false, disabled: false, **system_arguments) ⇒ Details

Returns a new instance of Details.

Parameters:

  • overlay (Symbol) (defaults to: NO_OVERLAY) —

    Dictates the type of overlay to render with. <%= one_of(Primer::Beta::Details::OVERLAY_MAPPINGS.keys) %>

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

    Defaults to false. If set to true, it will remove the default caret and remove style from the summary element

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

    Whether or not to disable the summary button.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'app/components/primer/beta/details.rb', line 85

def initialize(overlay: NO_OVERLAY, reset: false, disabled: false, **system_arguments)
  @system_arguments = deny_tag_argument(**system_arguments)
  @system_arguments[:tag] = :details
  @system_arguments[:classes] = class_names(
    system_arguments[:classes],
    OVERLAY_MAPPINGS[fetch_or_fallback(OVERLAY_MAPPINGS.keys, overlay, NO_OVERLAY)],
    "details-reset" => reset
  )
  @system_arguments[:data] = merge_data(
    @system_arguments, {
      data: {
        target: "details-toggle.detailsTarget",
      }
    }
  )
  # https://developer.mozilla.org/en-US/docs/Web/HTML/Element/details#open
  @open = !!@system_arguments[:open]
  @disabled = disabled
  @summary_info = nil
end

Instance Attribute Details

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

Returns the value of attribute disabled.


20
21
22
 
# File 'app/components/primer/beta/details.rb', line 20

def disabled
  @disabled
end

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

Returns the value of attribute open.


23
24
25
 
# File 'app/components/primer/beta/details.rb', line 23

def open
  @open
end

Instance Method Details

#render? ⇒ Boolean

Returns:

  • (Boolean) 

106
107
108
 
# File 'app/components/primer/beta/details.rb', line 106

def render?
  summary.present? && body.present?
end