Class: Primer::Alpha::SkeletonBox

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

Overview

A SkeletonBox provides a placeholder for non-text, non-Avatar elements (e.g., hero images) that are still loading. You can adjust width and height to match the content’s dimensions.

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 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(height: nil, width: nil, **system_arguments) ⇒ SkeletonBox

Returns a new instance of SkeletonBox.

Parameters:

  • height (String) (defaults to: nil) —

    Any valid CSS height.

  • width (String) (defaults to: nil) —

    Any valid CSS width.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'app/components/primer/alpha/skeleton_box.rb', line 13

def initialize(height: nil, width: nil, **system_arguments)
  @system_arguments = deny_tag_argument(**system_arguments)

  styles = []
  styles << "width: #{width}" if width
  styles << "height: #{height}" if height

  @system_arguments[:tag] = :div
  @system_arguments[:style] = styles.join("; ") if styles.present?
  @system_arguments[:classes] = class_names(
    @system_arguments.delete(:classes),
    "SkeletonBox"
  )
end