Avatar

Avatar represents people using icons, labels and images.

Import #


import { AvatarModule } from 'primeng/avatar';
import { AvatarGroupModule } from 'primeng/avatargroup';

Label #

A letter Avatar is defined with the label property.

Label
P
V
U
Label - Circle
P
V
U
Label - Badge
U4

<div class="col-12 md:col-4">
    <h5>Label</h5>
    <p-avatar label="P" styleClass="mr-2" size="xlarge"></p-avatar>
    <p-avatar label="V" styleClass="mr-2" size="large" [style]="{ 'background-color': '#2196F3', color: '#ffffff' }"></p-avatar>
    <p-avatar label="U" styleClass="mr-2" [style]="{ 'background-color': '#9c27b0', color: '#ffffff' }"></p-avatar>
</div>
<div class="col-12 md:col-4">
    <h5>Label - Circle</h5>
    <p-avatar label="P" styleClass="mr-2" size="xlarge" shape="circle"></p-avatar>
    <p-avatar label="V" styleClass="mr-2" size="large" [style]="{ 'background-color': '#2196F3', color: '#ffffff' }" shape="circle"></p-avatar>
    <p-avatar label="U" styleClass="mr-2" [style]="{ 'background-color': '#9c27b0', color: '#ffffff' }" shape="circle"></p-avatar>
</div>
<div class="col-12 md:col-4">
    <h5>Label - Badge</h5>
    <p-avatar label="U" pBadge styleClass="mr-5" value="4" size="large" [style]="{ 'background-color': '#4caf4f', color: '#ffffff' }"></p-avatar>
</div>

Icon #

A font icon is displayed as an Avatar with the icon property.

Icon
Icon - Circle
Icon - Badge
4

<p-avatar icon="pi pi-user" styleClass="mr-2" size="xlarge"></p-avatar>

Image #

Use the image property to display an image as an Avatar.


<p-avatar image="https://primefaces.org/cdn/primeng/images/demo/avatar/amyelsner.png" styleClass="mr-2" size="xlarge" shape="circle"></p-avatar>

Sizes #

size property defines the size of the Avatar with large and xlarge as possible values.

P
T

<p-avatar label="P" size="large"></p-avatar>
<p-avatar label="T" size="xlarge"></p-avatar>

AvatarGroup #

Grouping is available by wrapping multiple Avatar components inside an AvatarGroup.

+2

<p-avatarGroup styleClass="mb-3">
    <p-avatar image="https://primefaces.org/cdn/primeng/images/demo/avatar/amyelsner.png" size="large" shape="circle"></p-avatar>
    <p-avatar image="https://primefaces.org/cdn/primeng/images/demo/avatar/asiyajavayant.png" size="large" shape="circle"></p-avatar>
</p-avatarGroup>

Shape #

Avatar comes in two different styles specified with the shape property, square is the default and circle is the alternative.

P
T

<p-avatar label="P" shape="circle"></p-avatar>
<p-avatar label="T"></p-avatar>

Badge #

A badge can be added to an Avatar with the Badge directive.

4

<p-avatar image="https://primefaces.org/cdn/primeng/images/demo/avatar/amyelsner.png" pBadge value="4" severity="danger"></p-avatar>

Custom Content #

Content can easily be customized with the dynamic content instead of using the built-in modes.

Content

<p-avatar size="xlarge">
    <span class="text-base">Content</span>
</p-avatar>

Styling of Avatar #

Following is the list of structural style classes, for theming classes visit theming page.

NameElement
p-avatarContainer element.
p-avatar-imageContainer element in image mode.
p-avatar-circleContainer element with a circle shape.
p-avatar-textText of the Avatar.
p-avatar-iconIcon of the Avatar.
p-avatar-lgContainer element with a large size.
p-avatar-xlContainer element with an xlarge size.

Styling of AvatarGroup #

NameElement
p-avatar-groupContainer element.

Accessibility #

Screen Reader

Avatar does not include any roles and attributes by default. Any attribute is passed to the root element so you may add a role like img along with aria-labelledby or aria-label to describe the component. In case avatars need to be tabbable, tabIndex can be added as well to implement custom key handlers.

Keyboard Support

Component does not include any interactive elements.

PrimeNG 17.15.0 by PrimeTek