Avatar API

API reference docs for theAvatarcomponent. For examples and details on the usage of this component, visit the component demo page.

Props​

Props

Type

Description

Default

name

string

Displays the label with the user's name. If no image is provided, the avatar shows the first letter of the user's name.

_

size

'16' | '20' | '24' | '32' | '40' | '48' | '64' | '96'

The size attribute for the img element.

_

status?

'available' | 'away' | 'offline' | 'busy' | 'onCall' | 'audioCall' | 'customer'

Displays the user status.

_

children?

ReactNode

Content to be rendered inside Avatar.

_

isGuest?

boolean

Indicates if the avatar represents a guest. This applies a slightly different style to the status indicator, giving it a rounded rectangle shape.

false