Skip to content

Avatar

The Avatar component is used to represent a user with an image, icon, or text.

Props

PropTypeDefaultDescription
imagestring-URL of the avatar image
labelstring-Text to display when no image is provided
iconstring-Icon class to display when no image or label is provided
sizestring'md'Size of the avatar. Options: 'xs', 'sm', 'md', 'lg', 'xl', '2xl'

Basic Usage

html
<Avatar image="https://primefaces.org/cdn/primevue/images/avatar/amyelsner.png" />

Sizes

Avatar supports 6 different sizes: xs, sm, md, lg, xl, and 2xl.

html
<Avatar size="xs" label="XS" />
<Avatar size="sm" label="SM" />
<Avatar size="md" label="MD" />
<Avatar size="lg" label="LG" />
<Avatar size="xl" label="XL" />
<Avatar size="2xl" label="2XL" />
XS
SM
MD
LG
XL
2XL

Online Status

Add an online indicator by wrapping the avatar in a relative positioned div with an online indicator child:

html
  <div class="flex gap-4">
    <div class="relative inline-block">
      <Avatar
        size="2xl"
        image="https://primefaces.org/cdn/primevue/images/avatar/amyelsner.png"
      />
      <div
        style="position: absolute; bottom: -1px; right: 0px; width: 16px; height: 16px; border-radius: 9999px; border: 1.5px solid white; background-color: #22c55e; z-index: 10;"
      ></div>
    </div>
  </div>
</div>

Image with Different Sizes

html
<Avatar size="xs" image="https://primefaces.org/cdn/primevue/images/avatar/amyelsner.png" />
<Avatar size="sm" image="https://primefaces.org/cdn/primevue/images/avatar/amyelsner.png" />
<Avatar size="md" image="https://primefaces.org/cdn/primevue/images/avatar/amyelsner.png" />
<Avatar size="lg" image="https://primefaces.org/cdn/primevue/images/avatar/amyelsner.png" />
<Avatar size="xl" image="https://primefaces.org/cdn/primevue/images/avatar/amyelsner.png" />
<Avatar size="2xl" image="https://primefaces.org/cdn/primevue/images/avatar/amyelsner.png" />