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.
<%= 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" }) %>
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" }) %>
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" }) %>
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" }) %>
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.
Props | Type | Values |
---|---|---|
max_width |
array
|
xs
sm
md
lg
xl
xxl
0
none
|
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
|
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
|
|
dark |
boolean
|
|
id |
string
|
|
data |
hashprop
|
|
aria |
hashprop
|
|
children |
proc
|
Props | Type | Values | Default |
---|---|---|---|
image_url |
string
|
||
image_alt |
string
|
||
name |
string
|
||
size |
enum
|
xxs
xs
sm
md
base
lg
xl
|
md
|
status |
string
|