Ark Logo

Avatar

A graphical representation of the user, often used in profile sections.

JD

Anatomy

To set up the avatar correctly, you'll need to understand its anatomy and how we name its parts.

Each part includes a data-part attribute to help identify them in the DOM.

Examples

Learn how to use the Avatar component in your project. Let's take a look at the most basic example:

<script setup lang="ts">
import { Avatar } from '@ark-ui/vue'
</script>

<template>
  <Avatar.Root>
    <Avatar.Fallback>PA</Avatar.Fallback>
    <Avatar.Image src="https://i.pravatar.cc/3000" alt="avatar" />
  </Avatar.Root>
</template>

Handling Events

Avatar allows you to listen for loading state changes.

<script setup lang="ts">
import { Avatar } from '@ark-ui/vue'
</script>

<template>
  <Avatar.Root @status-change="(e) => console.log(e.status)">
    <Avatar.Fallback>PA</Avatar.Fallback>
    <Avatar.Image src="https://i.pravatar.cc/3000" alt="avatar" />
  </Avatar.Root>
</template>

API Reference

Root

PropDefaultType
asChildfalse
boolean

id
string

The unique identifier of the machine.

ids
Partial<{ root: string; image: string; fallback: string }>

The ids of the elements in the avatar. Useful for composition.

EmitEvent
statusChange
[details: StatusChangeDetails]

Functional called when the image loading status changes.

Fallback

PropDefaultType
asChildfalse
boolean

Data AttributeValue
[data-scope]avatar
[data-part]fallback
[data-state]"hidden" | "visible"

Image

PropDefaultType
asChildfalse
boolean

Data AttributeValue
[data-scope]avatar
[data-part]image
[data-state]"visible" | "hidden"