Avatar

Default

Documentation Vuesax Alpha

These docs refer to the Vue 3 support, to see the documents of the previous versions you can do it here 👉 Vuesax (4.0+)

Add an avatar easily and with functionality with the component <vs-avatar>

L

EY

Code Copied

• Template

<template>
  <div class="center con-avatars">
    <vs-avatar>
      <template #text> Lily </template>
    </vs-avatar>
    <vs-avatar>
      <template #text> Evan You </template>
    </vs-avatar>
    <vs-avatar>
      <i class="bx bx-user" />
    </vs-avatar>
    <vs-avatar color="primary">
      <i class="bx bxs-hot" />
    </vs-avatar>
    <vs-avatar>
      <img src="/avatars/avatar-5.png" alt="" />
    </vs-avatar>
  </div>
</template>

Color

Change the color of the compound with the color property, the colors allowed are the main colors of vuesax and (HEX, RGB)

P

S

D

W

D

HEX

RGB

Code Copied

• Template

<template>
  <div class="center con-avatars">
    <vs-avatar color="primary">
      <template #text> Primary </template>
    </vs-avatar>
    <vs-avatar color="success">
      <template #text> Success </template>
    </vs-avatar>
    <vs-avatar color="danger">
      <template #text> Danger </template>
    </vs-avatar>
    <vs-avatar color="warn">
      <template #text> Warn </template>
    </vs-avatar>
    <vs-avatar color="dark">
      <template #text> Dark </template>
    </vs-avatar>
    <vs-avatar color="#7d33ff">
      <template #text> HEX </template>
    </vs-avatar>
    <vs-avatar color="rgb(59,222,200)">
      <template #text> RGB </template>
    </vs-avatar>
  </div>
</template>
<style scoped lang="scss">
.con-avatars {
  .vs-avatar-content {
    margin: 10px;
  }
}
</style>

Size

Change the size of the component to the number provided if for example the size value is 60 equivalent to 60px in height and width

L

EY

Code Copied

• Template

<template>
  <div class="center con-avatars">
    <vs-avatar size="30">
      <template #text> Lily </template>
    </vs-avatar>
    <vs-avatar size="40" color="text">
      <template #text> Evan You </template>
    </vs-avatar>
    <vs-avatar color="success">
      <i class="bx bx-user" />
    </vs-avatar>
    <vs-avatar size="60" color="primary" badge badge-color="danger">
      <i class="bx bxs-hot" />
    </vs-avatar>
    <vs-avatar size="70" badge badge-color="success">
      <img src="/avatars/avatar-4.png" alt="" />
    </vs-avatar>
  </div>
</template>

Badge

Add a badge to the component with the badge property or the slot

You can also change the color to represent a user status as disconnected or connected with colors such as success or danger, this you do with the badge-color property

There are times when you need to use the avatar in a chat environment and for this you can add the writing property that adds a writing animation

28

Off

Code Copied

• Template

<template>
  <div class="center con-avatars">
    <vs-avatar badge>
      <img src="/avatars/avatar-5.png" alt="" />
    </vs-avatar>
    <vs-avatar badge badge-color="danger">
      <img src="/avatars/avatar-6.png" alt="" />
    </vs-avatar>
    <vs-avatar badge badge-color="success">
      <img src="/avatars/avatar-2.png" alt="" />
      <template #badge> 28 </template>
    </vs-avatar>
    <vs-avatar badge badge-color="warn">
      <img src="/avatars/avatar-8.png" alt="" />
      <template #badge>
        <i class="bx bxs-bell-off" />
      </template>
    </vs-avatar>
    <vs-avatar badge badge-color="danger">
      <img src="/avatars/avatar-9.png" alt="" />
      <template #badge> Off </template>
    </vs-avatar>
    <vs-avatar writing badge badge-color="primary">
      <img src="/avatars/avatar-3.png" alt="" />
    </vs-avatar>
    <vs-avatar badge-position="top-right" badge badge-color="#7d33ff">
      <img src="/avatars/avatar-1.png" alt="" />
    </vs-avatar>
  </div>
</template>

Auto font and split

If the user has a short name, it is added as it is but if it is a very long text or has several spaces, the text to be displayed will be automatically generated so that it can be seen correctly

The maximum length of characters is 5. When that limit is exceeded, changes are made in the text

L

J

F

SW

DRB

GREH

Code Copied

• Template

<template>
  <div class="center con-avatars">
    <vs-avatar>
      <template #text> L </template>
    </vs-avatar>
    <vs-avatar>
      <template #text> Joel </template>
    </vs-avatar>
    <vs-avatar>
      <template #text> Fanny </template>
    </vs-avatar>
    <vs-avatar>
      <template #text> Sally Willis </template>
    </vs-avatar>
    <vs-avatar>
      <template #text> Dakota Roche Brown </template>
    </vs-avatar>
    <vs-avatar>
      <template #text> Garret Reynolds Enarson Hoffman </template>
    </vs-avatar>
  </div>
</template>

Shape

Circle

Change the border-radius of the entire component to 50% with the circle property making it fully circular

J

F

Code Copied

• Template

<template>
  <div class="center con-avatars">
    <vs-avatar shape="circle">
      <template #text> Joel </template>
    </vs-avatar>
    <vs-avatar shape="circle" color="danger">
      <template #text> Fanny </template>
    </vs-avatar>
    <vs-avatar shape="circle">
      <img src="/avatars/avatar-1.png" alt="" />
    </vs-avatar>
    <vs-avatar shape="circle" badge>
      <img src="/avatars/avatar-2.png" alt="" />
    </vs-avatar>
    <vs-avatar shape="circle" badge writing badge-color="success">
      <img src="/avatars/avatar-3.png" alt="" />
    </vs-avatar>
    <vs-avatar
      badge
      shape="circle"
      badge-color="warn"
      badge-position="top-right"
    >
      <img src="/avatars/avatar-5.png" alt="" />
    </vs-avatar>
    <vs-avatar history history-gradient shape="circle">
      <img src="/avatars/avatar-6.png" alt="" />
    </vs-avatar>
  </div>
</template>
<style scoped lang="scss">
.con-avatars {
  .vs-avatar-content {
    margin: 10px;
  }
}
</style>

Square

Change the border-radius of the entire component to 0% with the square property making it completely square

J

F

Code Copied

• Template

<template>
  <div class="center con-avatars">
    <vs-avatar shape="square">
      <template #text> Joel </template>
    </vs-avatar>
    <vs-avatar shape="square" color="danger">
      <template #text> Fanny </template>
    </vs-avatar>
    <vs-avatar shape="square">
      <img src="/avatars/avatar-1.png" alt="" />
    </vs-avatar>
    <vs-avatar shape="square" badge>
      <img src="/avatars/avatar-2.png" alt="" />
    </vs-avatar>
    <vs-avatar shape="square" badge writing badge-color="success">
      <img src="/avatars/avatar-3.png" alt="" />
    </vs-avatar>
    <vs-avatar
      badge
      shape="square"
      badge-color="warn"
      badge-position="top-right"
    >
      <img src="/avatars/avatar-5.png" alt="" />
    </vs-avatar>
    <vs-avatar history history-gradient shape="square">
      <img src="/avatars/avatar-6.png" alt="" />
    </vs-avatar>
  </div>
</template>
<style scoped lang="scss">
.con-avatars {
  .vs-avatar-content {
    margin: 10px;
  }
}
</style>

History

It generates a border around the avatar, this is usually used to represent that the user is doing an action or in many cases has a History

You can make the border a gradient like instagram with the property history-gradient

Code Copied

• Template

<template>
  <div class="center con-avatars">
    <vs-avatar history>
      <img src="/avatars/avatar-5.png" alt="" />
    </vs-avatar>

    <vs-avatar history color="primary">
      <img src="/avatars/avatar-5.png" alt="" />
    </vs-avatar>

    <vs-avatar history color="success">
      <img src="/avatars/avatar-5.png" alt="" />
    </vs-avatar>

    <vs-avatar history history-gradient>
      <img src="/avatars/avatar-5.png" alt="" />
    </vs-avatar>
  </div>
</template>

Icon

You can put an icon inside an avatar when for example an image is not yet added or is a new user, for this you can simply use the default slot

Code Copied

• Template

<template>
  <div class="center con-avatars">
    <vs-avatar>
      <i class="bx bx-user" />
    </vs-avatar>
    <vs-avatar>
      <i class="bx bxs-camera" />
    </vs-avatar>
    <vs-avatar>
      <i class="bx bx-world" />
    </vs-avatar>
    <vs-avatar>
      <i class="bx bx-support" />
    </vs-avatar>
    <vs-avatar>
      <i class="bx bx-trophy" />
    </vs-avatar>
    <vs-avatar>
      <i class="bx bx-map" />
    </vs-avatar>
  </div>
</template>

Loading

Add a loading animation to the component, this property is a boolean so you can add it without any value

28

Code Copied

• Template

<template>
  <div class="center con-avatars">
    <vs-avatar shape="square">
      <template #text> Joel </template>
    </vs-avatar>
    <vs-avatar shape="square" color="danger">
      <template #text> Fanny </template>
    </vs-avatar>
    <vs-avatar shape="square">
      <img src="/avatars/avatar-1.png" alt="" />
    </vs-avatar>
    <vs-avatar shape="square" badge>
      <img src="/avatars/avatar-2.png" alt="" />
    </vs-avatar>
    <vs-avatar shape="square" badge writing badge-color="success">
      <img src="/avatars/avatar-3.png" alt="" />
    </vs-avatar>
    <vs-avatar
      badge
      shape="square"
      badge-color="warn"
      badge-position="top-right"
    >
      <img src="/avatars/avatar-5.png" alt="" />
    </vs-avatar>
    <vs-avatar history history-gradient shape="square">
      <img src="/avatars/avatar-6.png" alt="" />
    </vs-avatar>
  </div>
</template>
<style scoped lang="scss">
.con-avatars {
  .vs-avatar-content {
    margin: 10px;
  }
}
</style>

Icons

Add a space next to the avatar with the slot icons where you can put icons for some dynamic action of that user in specific

Code Copied

• Template

<template>
  <div class="center con-avatars">
    <vs-avatar>
      <img src="/avatars/avatar-1.png" alt="" />
      <template #icons>
        <i class="bx bxl-facebook-square" />
        <i class="bx bxl-github" />
        <i class="bx bxl-twitter" />
      </template>
    </vs-avatar>
    <vs-avatar badge badge-color="danger" badge-position="bottom-left">
      <img src="/avatars/avatar-8.png" alt="" />
      <template #icons>
        <i class="bx bxl-twitch" />
        <i class="bx bxl-discord" />
      </template>
    </vs-avatar>
    <vs-avatar loading badge badge-color="success" badge-position="top-left">
      <img src="/avatars/avatar-2.png" alt="" />
      <template #icons>
        <i class="bx bxl-patreon" />
        <i class="bx bxl-linkedin-square" />
        <i class="bx bx-link" />
      </template>
    </vs-avatar>
  </div>
</template>

Group

You can group several avatar with the parent component vs-avatar-group, this component has two interesting properties:

• max: determine the maximum number of avatars to show and the rest hides it generating the number in the last avatar shown

• float: causes the avatar components to be placed on each other and the grouping of one on top of the other is eliminated

+0

+0

Code Copied

• Template

<template>
  <div class="center con-avatars">
    <vs-avatar-group max="7">
      <vs-avatar>
        <img src="/avatars/avatar-1.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-6.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-2.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-7.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-3.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-8.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-4.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-9.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-5.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-10.png" alt="" />
      </vs-avatar>
    </vs-avatar-group>

    <vs-avatar-group float max="8">
      <vs-avatar>
        <img src="/avatars/avatar-1.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-6.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-2.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-7.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-3.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-8.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-4.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-9.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-5.png" alt="" />
      </vs-avatar>
      <vs-avatar>
        <img src="/avatars/avatar-10.png" alt="" />
      </vs-avatar>
    </vs-avatar-group>
  </div>
</template>

API