Documentation

Rounded:full

Avatars can have different radius factors. The following example shows avatars using the rounded prop. Avatars can also be displayed as groups, using the <BaseAvatarGroup> component.

Default shape of all <BaseAvatar> can be set in your <app>/app.config.ts.
Show code
vue

Rounded:lg

Avatars can have different radius factors. The following example shows avatars using the lg radius factor. Use the rounded prop to change the radius factor of the avatar.

Show code
vue

Rounded:md

Avatars can have different radius factors. The following example shows avatars using the md radius factor. Use the rounded prop to change the radius factor of the avatar.

Show code
vue

Rounded:sm

Avatars can have different radius factors. The following example shows avatars using the sm radius factor. Use the rounded prop to change the radius factor of the avatar.

Show code
vue

Rounded:none

Avatars can have different radius factors. The following example shows avatars using the none radius factor. Use the rounded prop to change the radius factor of the avatar.

Show code
vue

Avatar:circle:dot

Avatars can have status indicators. Indicators positioning vary depending on the shape of the avatar. Use the dot prop to display a status indicator.

Show code
vue

Avatar:curved:dot

Avatars can have status indicators. Indicators positioning vary depending on the shape of the avatar. Use the dot prop to display a status indicator.

Show code
vue

Avatar:circle:badge

Avatars can have image badges. Badges can be used to display a skill, a flag, an icon or any relevant information. Use the src-badge prop to display a badge.

Show code
vue

Avatar:curved:badge

Avatars can have image badges. Badges can be used to display a skill, a flag, an icon or any relevant information. Use the src-badge prop to display a badge.

Show code
vue

Avatar:fake:circle

Sometimes, you need to display a placeholder avatar. When an image is not provided, the component defaults to the fake mode, using color and text instead of an image.

CT
CT
CT
CT
CT
CT
CT
CT
CT
Show code
vue

Avatar:fake:curved

Sometimes, you need to display a placeholder avatar. When an image is not provided, the component defaults to the fake mode, using color and text instead of an image.

CT
CT
CT
CT
CT
CT
CT
CT
CT
Show code
vue

Fake:badge:circle

Fake avatars withstand the same props as regular avatars. You can also use badges and indicators on fake avatars using the same properties.

CT
CT
CT
CT
CT
CT
CT
CT
CT
Show code
vue

Fake:badge:curved

Fake avatars withstand the same props as regular avatars. You can also use badges and indicators on fake avatars using the same properties.

CT
CT
CT
CT
CT
CT
CT
CT
CT
Show code
vue

Fake:colors:circle

Fake avatars background and text color can be customized using Tailwind CSS bg-* and text-* utilities. Alternatively, you can use the Tairo getRandomColor() utility function to generate a random color.

CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
Show code
vue

Fake:colors:curved

Fake avatars background and text color can be customized using Tailwind CSS bg-* and text-* utilities. Alternatively, you can use the tairo getRandomColor() utility function to generate a random color.

CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
CT
Show code
vue

Avatar:mask

Avatars can be displayed using SVG masks, bringing fancier shapes to your UI. Keep in mind that the mask prop is only available for the none radius factor.

Using svg masks will hide any overflow from your avatar, making it unable to properly display badges, indicators or tooltips.
Show code
vue
badge-src
The URL of a badge to display on top of the image.
Show example
vue
classes
Optional CSS classes to apply to the component inner elements.
Show example
vue
dot
Whether to display a dot on top of the image, or the color of the dot.
Show example
vue
mask
Applies an svg mask from the available presets. (needs rounded to be set to `none`).
Show example
vue
ring
Whether to display a ring around the image .
Show example
vue
src
The URL of the image to display.
Show example
vue
src-dark
The URL of a dark version of the image to display when the component is in dark mode.
Show example
vue
text
The text to display below the image.
Show example
vue
color
Defines the color of the avatar

@since

3.0.0

Show example
vue
rounded
The radius of the image.
Show example
vue
size
The size of the image.
Show example
vue
#default
This slot has no inherted props
Show example
vue
#badge
This slot has no inherted props
Show example
vue
color
Defines the color of the avatar
Show example
vue
rounded
The radius of the image.
Show example
vue
size
The size of the image.
Show example
vue