Avatar

Avatar displays a user's picture. This helps aid easy recognition of the user. This kit is normally not used by itself, but rather used within other kits.
The only time Avatar should be used instead of the User kit is when you are not going to display the user's name.

Summary

Uses Icons

Default

<%= pb_rails("avatar", props: {
    name: "Terry Johnson",
    size: "xxs",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    status: "away"
  }) %>

<br>

<%= pb_rails("avatar", props: {
    name: "Terry Johnson",
    size: "xs",
    image_alt: "Terry Johnson Standing",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    status: "online"
  }) %>

<br>

<%= pb_rails("avatar", props: {
    name: "Terry Johnson",
    size: "sm",
    image_alt: "Terry Johnson Standing",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    status: "away"
  }) %>

<br>

<%= pb_rails("avatar", props: {
    name: "Terry Johnson",
    size: "md",
    image_alt: "Terry Johnson Standing",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    status: "offline"
  }) %>

<br>

<%= pb_rails("avatar", props: {
    name: "Terry Johnson",
    size: "lg",
    image_alt: "Terry Johnson Standing",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    status: "online"
  }) %>

<br>

<%= pb_rails("avatar", props: {
    name: "Terry Johnson",
    size: "xl",
    image_alt: "Terry Johnson Standing",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    status: "away"
  }) %>

Monogram

This is used when there is no avatar for a particular user.

<%= pb_rails("avatar", props: { name: "Terry Johnson", size: "xxs" }) %>
<%= pb_rails("avatar", props: { name: "Terry Johnson", size: "xs" }) %>
<%= pb_rails("avatar", props: { name: "Terry Johnson", size: "sm" }) %>
<%= pb_rails("avatar", props: { name: "Terry Johnson", size: "md" }) %>
<%= pb_rails("avatar", props: { name: "Terry Johnson", size: "lg" }) %>
<%= pb_rails("avatar", props: { name: "Terry Johnson", size: "xl" }) %>

Bad Image Link

A monagram is used as a fallback when an invalid or missing image url is provided.

<%= pb_rails("avatar", props: { image_url: "", name: "Terry Johnson", size: "xxs" }) %>
<%= pb_rails("avatar", props: { image_url: true, name: "Terry Johnson", size: "xs" }) %>
<%= pb_rails("avatar", props: { image_url: 4, name: "Terry Johnson", size: "sm" }) %>
<%= pb_rails("avatar", props: { image_url: "https://google.com", name: "Terry Johnson", size: "md" }) %>
<%= pb_rails("avatar", props: { image_url: "", name: "Terry Johnson", size: "lg" }) %>
<%= pb_rails("avatar", props: { image_url: "https://randomuser.me/api/portraits/men/notapicture.jpg", name: "Terry Johnson", size: "xl" }) %>

Status

The Status prop is used to display a user's online status like popular chat apps.

<%= pb_rails("avatar", props: {
    name: "Terry Johnson",
    size: "sm",
    image_alt: "Terry Johnson Status",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg"
  }) %>

<br>

  <%= pb_rails("avatar", props: {
    name: "Terry Johnson",
    size: "sm",
    image_alt: "Terry Johnson Online",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    status: "online"
  }) %>

  <br>

<%= pb_rails("avatar", props: {
    name: "Terry Johnson",
    size: "sm",
    image_alt: "Terry Johnson Away",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    status: "away"
  }) %>

  <br>

<%= pb_rails("avatar", props: {
    name: "Terry Johnson",
    size: "sm",
    image_alt: "Terry Johnson Offline",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    status: "offline"
  }) %>

Icon Circle Component Overlay

NOTE: All componentOverlay implementations require a placement prop, that accepts any of the following values: top-right, top-left, bottom-right, bottom-left, top-center, bottom-center, left-center, and right-center.

When passing the iconCircle component as an overlay, you must also specify an icon, and you may optionally control the color by passing an approved value as a variant.

  <%= pb_rails("avatar", props: {
    component_overlay: {
        component: "icon_circle",
        icon: "shield",
        placement: "bottom-right",
        variant: "royal"
    },
    name: "Terry Johnson",
    size: "sm",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    margin_bottom: "sm"
  }) %>

  <%= pb_rails("avatar", props: {
    component_overlay: {
        component: "icon_circle",
        icon: "check",
        placement: "top-right",
        variant: "green"
    },
    name: "Terry Johnson",
    size: "md",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    margin_bottom: "sm"
  }) %>

  <%= pb_rails("avatar", props: {
    component_overlay: {
        component: "icon_circle",
        icon: "lock",
        placement: "top-left",
        variant: "red"
    },
    name: "Terry Johnson",
    size: "lg",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    margin_bottom: "sm"
  }) %>

  <%= pb_rails("avatar", props: {
    component_overlay: {
        component: "icon_circle",
        icon: "star",
        placement: "left-center",
        variant: "yellow"
    },
    name: "Terry Johnson",
    size: "xl",
    image_url: "https://randomuser.me/api/portraits/men/44.jpg",
    margin_bottom: "sm"
  }) %>

Badge Component Overlay

On Roadtrip

Out of Office

When passing the badge component as an overlay, you must also specify its text content,and you may optionally control the color by passing an approved value as a variant.

 <%= pb_rails("avatar", props: {
      component_overlay: {
          component: "badge",
          text: "12",
          placement: "bottom-right"
      },
      name: "Terry Johnson",
      size: "sm",
      image_url: "https://randomuser.me/api/portraits/men/44.jpg",
      margin_bottom: "sm"
    }) %>

    <%= pb_rails("avatar", props: {
      component_overlay: {
          component: "badge",
          text: "12",
          placement: "top-left"
      },
      name: "Terry Johnson",
      size: "md",
      image_url: "https://randomuser.me/api/portraits/men/44.jpg",
      margin_bottom: "sm"
    }) %>

    <%= pb_rails("avatar", props: {
      component_overlay: {
          component: "badge",
          text: "On Roadtrip",
          placement: "top-center",
          variant: "info"
      },
      name: "Terry Johnson",
      size: "lg",
      image_url: "https://randomuser.me/api/portraits/men/44.jpg",
      margin_bottom: "sm"
    }) %>

    <%= pb_rails("avatar", props: {
      component_overlay: {
          component: "badge",
          text: "Out of Office",
          placement: "bottom-center",
          variant: "error"
      },
      name: "Terry Johnson",
      size: "xl",
      image_url: "https://randomuser.me/api/portraits/men/44.jpg",
      margin_bottom: "sm"
    }) %>

Things to Avoid

Avoid using Avatar with the user's name right next to it or under it. Use User kit instead. Do not use this kit for images that are not profile pictures.

Available Props

Props	Type	Values
max_width	array	0% xs sm md lg xl xxl 0 none 100%
min_width	array	0% xs sm md lg xl xxl 0 none 100%
width	array	0% xs sm md lg xl xxl 0 none 100%
z_index	array	1 2 3 4 5 6 7 8 9 10
number_spacing	array	tabular
shadow	array	none deep deeper deepest
line_height	array	tightest tighter tight normal loose looser loosest
display	array	block inline_block inline flex inline_flex none
cursor	array	auto default none contextMenu help pointer progress wait cell crosshair text verticalText alias copy move noDrop notAllowed grab grabbing eResize nResize neResize nwResize sResize seResize swResize wResize ewResize nsResize neswResize nwseResize colResize rowResize allScroll zoomIn zoomOut
flex_direction	array	row column rowReverse columnReverse
flex_wrap	array	wrap nowrap wrapReverse
justify_content	array	start end center spaceBetween spaceAround spaceEvenly
justify_self	array	auto start end center stretch
align_items	array	flexStart flexEnd start end center baseline stretch
align_content	array	start end center spaceBetween spaceAround spaceEvenly
align_self	array	auto start end center stretch baseline
flex	array	auto initial 0 1 2 3 4 5 6 7 8 9 10 11 12 none
flex_grow	array	1 0
flex_shrink	array	1 0
order	array	1 2 3 4 5 6 7 8 9 10 11 12
position	array	relative absolute fixed sticky
hover	array
border_radius	array	none xs sm md lg xl rounded
text_align	array	start end left right center justify justify-all match-parent
overflow	array	visible hidden scroll auto
truncate	array	1 2 3 4 5
left	array	0 xxs xs sm md lg xl auto initial inherit
top	array	0 xxs xs sm md lg xl auto initial inherit
right	array	0 xxs xs sm md lg xl auto initial inherit
bottom	array	0 xxs xs sm md lg xl auto initial inherit
vertical_align	array	baseline super top middle bottom sub text-top text-bottom
height	array	auto xs sm md lg xl xxl xxxl
min_height	array	auto xs sm md lg xl xxl xxxl
max_height	array	auto xs sm md lg xl xxl xxxl
overflow_x	array	visible hidden scroll auto
overflow_y	array	visible hidden scroll auto
margin	array	none xxs xs sm md lg xl
margin_bottom	array	none xxs xs sm md lg xl
margin_left	array	none xxs xs sm md lg xl
margin_right	array	none xxs xs sm md lg xl
margin_top	array	none xxs xs sm md lg xl
margin_x	array	none xxs xs sm md lg xl
margin_y	array	none xxs xs sm md lg xl
padding	array	none xxs xs sm md lg xl
padding_bottom	array	none xxs xs sm md lg xl
padding_left	array	none xxs xs sm md lg xl
padding_right	array	none xxs xs sm md lg xl
padding_top	array	none xxs xs sm md lg xl
padding_x	array	none xxs xs sm md lg xl
padding_y	array	none xxs xs sm md lg xl
classname	string
group_hover	boolean
id	string
data	hashprop
aria	hashprop
html_options	hashprop
children	proc
style	hashprop

Props	Type	Values	Default
dark	boolean		false
component_overlay	string
image_url	string
image_alt	string
name	string
size	enum	xxs xs sm md base lg xl	md
status	string

Contribute to Playbook

When you start designing a new feature, you may come across a Design Token or Component that isn’t defined in Playbook. If so, you should open an issue or reach out to the team to make a contribution.

Contribute on GitHub

As the highest-rated residential remodeler in the nation, our international technology team builds a custom suite of products that continuously transform our business.

Power

Tech @ Power

Open Positions

About Power

Connect

Dribbble

Github

Connect Chat

Avatar

Things to Avoid

Available Props

max_width

min_width

width

z_index

number_spacing

shadow

line_height

display

cursor

flex_direction

flex_wrap

justify_content

justify_self

align_items

align_content

align_self

flex

flex_grow

flex_shrink

order

position

hover

border_radius

text_align

overflow

truncate

left

top

right

bottom

vertical_align

height

min_height

max_height

overflow_x

overflow_y

margin

margin_bottom

margin_left

margin_right

margin_top

margin_x

margin_y

padding

padding_bottom

padding_left

padding_right

padding_top

padding_x

padding_y

classname

group_hover

id

data

aria

html_options

children

style

dark

component_overlay

image_url

image_alt

name

size

status

Contribute to Playbook

Power

Connect