Sha256: d9633ab18fa409a9a1e27c4f18de97c2c9a34a389ab1873880877104f3b56d4c
Contents?: true
Size: 1.42 KB
Versions: 7
Compression:
Stored size: 1.42 KB
Contents
# frozen_string_literal: true
module Primer
# Use `Image` to render images.
#
# @accessibility
# Always provide a meaningful `alt`.
class Image < Primer::Component
# @example Default
#
# <%= render(Primer::Image.new(src: Primer::ExampleImage::BASE64_SRC, alt: "GitHub")) %>
#
# @example Helper
#
# <%= primer_image(src: Primer::ExampleImage::BASE64_SRC, alt: "GitHub") %>
#
# @example Lazy loading
#
# <%= render(Primer::Image.new(src: Primer::ExampleImage::BASE64_SRC, alt: "GitHub", lazy: true)) %>
#
# @example Custom size
#
# <%= render(Primer::Image.new(src: Primer::ExampleImage::BASE64_SRC, alt: "GitHub", height: 100, width: 100)) %>
#
# @param src [String] The source url of the image.
# @param alt [String] Specifies an alternate text for the image.
# @param lazy [Boolean] Whether or not to lazily load the image.
# @param system_arguments [Hash] <%= link_to_system_arguments_docs %>
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
def call
render(Primer::BaseComponent.new(src: image_path(@src), **@system_arguments))
end
end
end
Version data entries
7 entries across 7 versions & 1 rubygems