Class: Primer::Beta::AvatarStack

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

Overview

Use ‘AvatarStack` to stack multiple avatars together.

Constant Summary collapse

ALIGN_DEFAULT = 
:left
ALIGN_OPTIONS = 
[ALIGN_DEFAULT, :right].freeze
DEFAULT_TAG = 
:div
TAG_OPTIONS = 
[DEFAULT_TAG, :span].freeze
DEFAULT_BODY_TAG = 
:div
BODY_TAG_OPTIONS = 
[DEFAULT_BODY_TAG, :span].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 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(tag: DEFAULT_TAG, align: ALIGN_DEFAULT, tooltipped: false, disable_expand: false, body_arguments: {}, **system_arguments) ⇒ AvatarStack

Returns a new instance of AvatarStack.

Parameters:

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

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

  • align (Symbol) (defaults to: ALIGN_DEFAULT) —

    <%= one_of(Primer::Beta::AvatarStack::ALIGN_OPTIONS) %>

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

    Whether to add a tooltip to the stack or not.

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

    Whether to disable the expand behavior on hover. If true, avatars will not expand.

  • body_arguments (Hash) (defaults to: {}) —

    Parameters to add to the Body. If ‘tooltipped` is set, has the same arguments as <%= link_to_component(Primer::Tooltip) %>. The default tag is <%= pretty_value(Primer::Beta::AvatarStack::DEFAULT_BODY_TAG) %> but can be changed using `tag:` to <%= one_of(Primer::Beta::AvatarStack::BODY_TAG_OPTIONS, lower: true) %>

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'app/components/primer/beta/avatar_stack.rb', line 30

def initialize(tag: DEFAULT_TAG, align: ALIGN_DEFAULT, tooltipped: false, disable_expand: false, body_arguments: {}, **system_arguments)
  @align = fetch_or_fallback(ALIGN_OPTIONS, align, ALIGN_DEFAULT)
  @system_arguments = system_arguments
  @tooltipped = tooltipped
  @disable_expand = disable_expand
  @body_arguments = body_arguments
  @direction = @body_arguments[:direction]

  body_tag = @body_arguments[:tag] || DEFAULT_BODY_TAG
  @body_arguments[:tag] = fetch_or_fallback(BODY_TAG_OPTIONS, body_tag, DEFAULT_BODY_TAG)
  @body_arguments[:classes] = class_names(
    "AvatarStack-body",
    @body_arguments[:classes]
  )
  @body_arguments[:"data-disable-expand"] = true if @disable_expand

  @system_arguments[:tag] = fetch_or_fallback(TAG_OPTIONS, tag, DEFAULT_TAG)
  @system_arguments[:classes] = class_names(
    "AvatarStack",
    system_arguments[:classes],
    "AvatarStack--right" => @align == :right
  )

  @body_arguments[:tabindex] = tooltipped ? 0 : nil
  @body_arguments[:id] = tooltipped ? @body_arguments[:id] ||= self.class.generate_id : @body_arguments[:id]

  @tooltip_arguments = {
    for_id: @body_arguments[:id],
    direction: @body_arguments.delete(:direction),
  }

  @tooltip_arguments[:direction] = @direction || Primer::Alpha::Tooltip::DIRECTION_DEFAULT
  @tooltip_arguments[:text] = @body_arguments[:label]
  @tooltip_arguments[:type] = :description

  @body_arguments[:aria] ||= {}
  if tooltipped && @body_arguments[:label].present?
    @body_arguments[:aria][:label] = @body_arguments[:label]
    @body_arguments[:label] = nil
  end
end

Instance Method Details

#before_render ⇒ Object 



76
77
78
79
80
81
82
 
# File 'app/components/primer/beta/avatar_stack.rb', line 76

def before_render
  @system_arguments[:classes] = class_names(
    @system_arguments[:classes],
    "AvatarStack--two" => avatars.size == 2,
    "AvatarStack--three-plus" => avatars.size > 2
  )
end

#body_component ⇒ Object 



72
73
74
 
# File 'app/components/primer/beta/avatar_stack.rb', line 72

def body_component
  Primer::BaseComponent.new(**@body_arguments)
end

#render? ⇒ Boolean

Returns:

  • (Boolean) 


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

def render?
  avatars.any?
end