Class: Primer::AvatarComponent

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

Overview

‘Avatar` can be used to represent users and organizations on GitHub.

  • Use the default round avatar for users, and the ‘square` argument

for organizations or any other non-human avatars.

  • By default, ‘Avatar` will render a static `<img>`. To have `Avatar` function as a link, set the `href` which will wrap the `<img>` in a `<a>`.

  • Set ‘size` to update the height and width of the `Avatar` in pixels.

  • To stack multiple avatars together, use <%= link_to_component(Primer::AvatarStackComponent) %>.

Constant Summary collapse

SMALL_THRESHOLD = 
24

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

Instance Method Summary collapse

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

Constructor Details

#initialize(src:, alt:, size: 20, square: false, href: nil, **system_arguments) ⇒ AvatarComponent

Returns a new instance of AvatarComponent.

Examples:

Default

<%= render(Primer::AvatarComponent.new(src: "http://placekitten.com/200/200", alt: "@kittenuser")) %>

Square

<%= render(Primer::AvatarComponent.new(src: "http://placekitten.com/200/200", alt: "@kittenuser", square: true)) %>

Link

<%= render(Primer::AvatarComponent.new(href: "#", src: "http://placekitten.com/200/200", alt: "@kittenuser profile")) %>

With size

<%= render(Primer::AvatarComponent.new(src: "http://placekitten.com/200/200", alt: "@kittenuser", size: 16)) %>
<%= render(Primer::AvatarComponent.new(src: "http://placekitten.com/200/200", alt: "@kittenuser", size: 20)) %>
<%= render(Primer::AvatarComponent.new(src: "http://placekitten.com/200/200", alt: "@kittenuser", size: 24)) %>
<%= render(Primer::AvatarComponent.new(src: "http://placekitten.com/200/200", alt: "@kittenuser", size: 28)) %>
<%= render(Primer::AvatarComponent.new(src: "http://placekitten.com/200/200", alt: "@kittenuser", size: 32)) %>
<%= render(Primer::AvatarComponent.new(src: "http://placekitten.com/200/200", alt: "@kittenuser", size: 36)) %>

Parameters:

  • src (String) —

    The source url of the avatar image.

  • alt (String) —

    Passed through to alt on img tag.

  • size (Integer) (defaults to: 20) —

    Adds the avatar-small class if less than 24.

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

    Used to create a square avatar.

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

    The URL to link to. If used, component will be wrapped by an ‘<a>` tag.

  • system_arguments (Hash) —

    <%= link_to_system_arguments_docs %>



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'app/components/primer/avatar_component.rb', line 46

def initialize(src:, alt:, size: 20, square: false, href: nil, **system_arguments)
  @href = href
  @system_arguments = system_arguments
  @system_arguments[:tag] = :img
  @system_arguments[:src] = src
  @system_arguments[:alt] = alt
  @system_arguments[:size] = size
  @system_arguments[:height] = size
  @system_arguments[:width] = size

  @system_arguments[:classes] = class_names(
    system_arguments[:classes],
    "avatar",
    "avatar-small" => size < SMALL_THRESHOLD,
    "circle" => !square,
    "lh-0" => href # Addresses an overflow issue with linked avatars
  )
end

Instance Method Details

#call ⇒ Object 



65
66
67
68
69
70
71
72
73
 
# File 'app/components/primer/avatar_component.rb', line 65

def call
  if @href
    render(Primer::LinkComponent.new(href: @href, classes: @system_arguments[:classes])) do
      render(Primer::BaseComponent.new(**@system_arguments.except(:classes))) { content }
    end
  else
    render(Primer::BaseComponent.new(**@system_arguments)) { content }
  end
end