DocsComponentsAvatar

Avatar

The Avatar Component is used to represent a user's profile picture, initial or fallback icon.

Usage

Sizes

Disabled

Bordered

Radius

Colors

Avatar Fallbacks

If the src is not passed or it's empty there are 2 fallbacks.

  • If there is the alt attribute, it will be used as the name of the avatar.
  • If there is neither src nor alt attribute, a default icon will be used.

If the data-show-fallback="true" is not passed, the fallbacks will not be displayed.

Custom Fallback

To customize the dault fallback icon, use the <div class-"fallback"></div> and your icon inside.

Avatar Group

Note: If you set the tabindex attribute, it makes the avatar focusable for keyboard navigation and will add the focus ring when focused.

Group Disabled

Group Max Count

You can limit the number of avatars displayed by passing the data-max attribute and set the value as your desire.

Group Total Count

You can display the total number of avatars by passing the data-total attribute and set the value as your desire.

Group Custom Count

You can also customize the count displayed when the data-total attribute is passed using the data-count and the data-count-class attributes.

Group Grid

By passing the data-grid attribute to the avatar-group element, the avatars will be displayed in a grid layout.

Slots

  • avatar: Avatar wrapper which includes styles for focus ring, position, and general appearance.
  • img: Image element within the avatar which includes styles for opacity transition and size.
  • fallback: Fallback content when the image fails to load or is not provided which includes styles for centering the content (dynamic).
  • name: Initials displayed when the image is not provided or fails to load which includes styles for font, text alignment, and inheritance (dynamic).
  • icon: Default Icon element within the avatar which includes styles for centering the content, text inheritance, and size (dynamic).

Custom Avatar Styles

You can customize any part of the avatar by using different tailwind classes like this:

Data Attributes

Avatar has the following attributes on the base element:

  • data-disabled: Whether the avatar is disabled.
  • data-bordered: Adds a border around the avatar.
  • data-show-fallback: Shows the fallback icon or initials when the image fails to load.

AvatarGroup has the following attributes on the base element:

  • data-disabled: Whether the avatar group is disabled.
  • data-max: The maximum number of visible avatars.
  • data-total: Control the number of avatar not visible.
  • data-grid: Whether the avatars should be displayed in a grid.
  • data-count: The text inside the custom count.
  • data-count-class: The classes for customizing the custom count.

Avatar Properties

PropertyTypeDescriptionDefault
sizesm | md | lgThe size of the code.md
colorforeground | default | primary | secondary | success | warning | dangerThe color of the code.default
radiusnone | sm | md | lg | fullThe radius of the code.full
data-bordered"true" | "false"Adds a border around the avatar.false
data-disabled"true" | "false"Disables the avatar and applies a disabled styling.false
data-show-fallback"true" | "false"Shows the fallback icon or initials when the image fails to load.false

Avatar Group Properties

PropertyTypeDescriptionDefault
data-maxstring (numeric)The maximum number of visible avatars.5
data-totalstring (numeric)Control the number of avatar not visible.-
data-countstringThe text inside the custom count.-
data-count-classstringThe classes for customizing the custom count.-
data-grid"true" | "false"Whether the avatars should be displayed in a grid.false
data-disabled"true" | "false"Disables the avatar group and applies a disabled styling.false