Skip to content

Avatar ​

Use the avatar component to show a visual representation of a user profile using an image element or SVG object based on multiple styles and sizes

Examples ​

Shape ​

The Avatar component creates an image within its shape.

Code
vue
<template>
  <div>
    <base-avatar src="https://placehold.co/150" shape="circle" name="John Doe" />
    <base-avatar src="https://placehold.co/150" shape="square" name="John Doe" />
    <base-avatar src="https://placehold.co/150" shape="squircle" name="John Doe" />
  </div>
</template>

Initial ​

In the absence of a image, you can use the initial. Initials can be used in various variants.

Code
vue
<template>
  <div>
    <base-avatar name="John" />
    <base-avatar name="John Doe" />
    <base-avatar name="John Doe Rock" />
  </div>
</template>

Color ​

In the absence of a image, you can use the initial.

Code
vue
<template>
  <div>
    <base-avatar color="primary" name="John Doe" />
    <base-avatar color="secondary" name="John Doe" />
    <base-avatar color="info" name="John Doe" />
    <base-avatar color="success" name="John Doe" />
    <base-avatar color="warning" name="John Doe" />
    <base-avatar color="danger" name="John Doe" />
  </div>
</template>

Indicator ​

Avatars can be a dot attached to it. It can be used to indicate the user status.

Code
vue


<template>
  <base-avatar src="https://placehold.co/150" name="John Doe" indicator colorIndicator="primary" />
  <base-avatar src="https://placehold.co/150" name="John Doe" indicator colorIndicator="secondary" />
  <base-avatar src="https://placehold.co/150" name="John Doe" indicator colorIndicator="info" />
  <base-avatar src="https://placehold.co/150" name="John Doe" indicator colorIndicator="success" />
  <base-avatar src="https://placehold.co/150" name="John Doe" indicator colorIndicator="warning" />
  <base-avatar src="https://placehold.co/150" name="John Doe" indicator colorIndicator="danger" />
</template>

Size ​

The Avatar component can have various size.

Code
vue


<template>
  <div>
    <base-avatar indicator src="https://placehold.co/150" shape="circle" name="John Doe" :size="128" />
    <base-avatar indicator src="https://placehold.co/150" shape="circle" name="John Doe" :size="96" />
    <base-avatar indicator src="https://placehold.co/150" shape="circle" name="John Doe" :size="64" />
    <base-avatar indicator src="https://placehold.co/150" shape="circle" name="John Doe" :size="48" />
    <base-avatar indicator src="https://placehold.co/150" shape="circle" name="John Doe" :size="32" />
  </div>
</template>

Group ​

The Avatar group renders its children as a stack.

Code
vue


<template>
  <div>
    <base-avatar-group>
      <base-avatar src="https://placehold.co/150" />
      <base-avatar src="https://placehold.co/150" />
      <base-avatar src="https://placehold.co/150" />
      <base-avatar src="https://placehold.co/150" />
    </base-avatar-group>
  </div>
</template>

Animate ​

Hover the Avatar to activate slide animation.

Code
vue
<template>
  <div>
    <base-avatar-group>
      <base-avatar src="https://placehold.co/150" animate indicator />
      <base-avatar src="https://placehold.co/150" animate indicator />
      <base-avatar src="https://placehold.co/150" animate indicator />
      <base-avatar src="https://placehold.co/150" animate indicator />
    </base-avatar-group>
  </div>
</template>

Avatar Group API ​

Slot ​

#default slot for rendering avatars

Avatar API ​

Types ​

ts
export type BaseAvatarColorType =
  | 'primary'
  | 'secondary'
  | 'info'
  | 'success'
  | 'warning'
  | 'danger'
export type BaseAvatarShapeType = 'square' | 'squircle' | 'circle'

Props ​

NameTypeDefaultDescription
namestringAvatar name is required.
srcstringAvatar image source file.
colorprimary secondary info success warning dangersecondaryAvatar color.
sizenumber64Avatar size.
shapesquare circle squirclecircleAvatar shape.
indicatorbooleanfalseAvatar indicator.
colorIndicatorprimary secondary info success warning dangersuccessAvatar color indicator.

Released under the MIT License.