Class: Primer::Alpha::Image

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

Overview

Use ‘Image` to render images.

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(src:, alt:, lazy: false, **system_arguments) ⇒ Image

Returns a new instance of Image.

Parameters:

  • src (String) —

    The source url of the image.

  • alt (String) —

    Specifies an alternate text for the image.

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

    Whether or not to lazily load the image.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



16
17
18
19
20
21
22
23
24
25
26
27
 
# File 'app/components/primer/alpha/image.rb', line 16

def initialize(src:, alt:, lazy: false, **system_arguments)
  @system_arguments = deny_tag_argument(**system_arguments)

  @src = src
  @system_arguments[:tag] = :img
  @system_arguments[:alt] = alt

  return unless lazy

  @system_arguments[:loading] = :lazy
  @system_arguments[:decoding] = :async
end

Instance Method Details

#call ⇒ Object 



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

def call
  render(Primer::BaseComponent.new(src: image_path(@src), **@system_arguments))
end