Avatar

An image element with a fallback for representing the user.

Prop	Default	Type	Description
`src`	-	`string`	The image source.
`alt`	-	`string`	The alternative text.
`label`	-	`string`	The placeholder of the avatar when it is loading. By default, it uses the first letters of each word in the `alt` prop.

Prop	Default	Type	Description
`avatar`	`soft`	`{variant}`	The variant of the avatar.

Variant	Description
`soft`	The default variant.
`solid`	The solid variant.
`outline`	The outline variant.
`~`	The unstyle or base variant

Color

Prop	Default	Type	Description
`avatar`	`{variant}-gray`	`{variant}-{color}`	The color of the avatar.

Preview

Code

Dynamic colors:

PRPRPRPRPRPR

Static colors:

PRPR

Prop	Default	Type	Description
`icon`	`false`	boolean	If true, the label will be wrapped as an Icon component. The label can be passed as the `name` of the icon.

Size and Square

Prop	Default	Type	Description
`size`	`md`	`string`	Sets the size of the avatar.
`square`	`2.5rem`	`string`	Sets the avatar to a square shape with specified dimensions. This does not affect the size of the fallback value.

🚀 Adjust input size freely using any size, breakpoints (e.g., sm:sm, xs:lg), or states (e.g., hover:lg, focus:3xl).

The padding, icons, and text-size of the input scale are dynamically adjusted based on the size property. To customize the text-size and padding simultaneously, you can use utility classes.

Preview

Code

Rounded

Prop	Default	Type	Description
`rounded`	`full`	`string`	Set the avatar to have rounded corners.

Preview

Code

With Indicator

Preview

Code

PRNewNew

Customization

You can customize the avatar using the una prop and utility classes.

Preview

Code

PRPR

Slots

Slot	Props	Description
`default`	-	The image element of the avatar.
`fallback`	-	The fallback element of the avatar.

Preview

Code

Presets

shortcuts/avatar.ts

type AvatarPrefix = 'avatar'

export const staticAvatar: Record<`${AvatarPrefix}-${string}` | AvatarPrefix, string> = {
  // base
  'avatar': 'relative inline-flex items-center font-normal select-none shrink-0 overflow-hidden',
  'avatar-image': 'h-full w-full object-cover',
  'avatar-fallback': 'flex h-full w-full items-center justify-center',

  'avatar-label': 'uppercase',
  'avatar-icon': 'text-1em',

  // variants
  'avatar-solid-white': 'bg-base text-base border border-base',
  'avatar-solid-black': 'bg-inverted text-inverted',
}

export const dynamicAvatar: [RegExp, (params: RegExpExecArray) => string][] = [
  // variants
  [/^avatar-solid(-(\S+))?$/, ([, , c = 'gray']) => `bg-${c}-600 dark:bg-${c}-500 text-inverted`],
  [/^avatar-soft(-(\S+))?$/, ([, , c = 'gray']) => `bg-${c}-50 text-${c}-700 dark:text-${c}-400 dark:bg-${c}-900`],
  [/^avatar-outline(-(\S+))?$/, ([, , c = 'gray']) => `bg-transparent text-${c}-500 dark:text-${c}-400 border border-${c}-500 dark:border-${c}-400`],
]

export const avatar = [
  ...dynamicAvatar,
  staticAvatar,
]

Props

types/avatar.ts

import type { AvatarFallbackProps, AvatarImageProps, AvatarRootProps } from 'reka-ui'
import type { HTMLAttributes } from 'vue'

interface BaseProps {
  class?: HTMLAttributes['class']
  /**
   * Set the size of the avatar.
   */
  size?: HTMLAttributes['class']
  /**
   * Set the height and width of the avatar.
   */
  square?: HTMLAttributes['class']
  /**
   * Set the border radius of the avatar.
   */
  rounded?: HTMLAttributes['class']
}

export interface NAvatarProps extends BaseProps, NAvatarRootProps, NAvatarAvatarFallbackProps, NAvatarImageProps {
  _avatarRoot?: NAvatarRootProps
  _avatarImage?: NAvatarImageProps
  _avatarFallback?: NAvatarAvatarFallbackProps
  /**
   * `UnaUI` preset configuration
   *
   * @see https://github.com/una-ui/una-ui/blob/main/packages/preset/src/_shortcuts/avatar.ts
   */
  una?: NAvatarUnaProps
}

export interface NAvatarRootProps extends AvatarRootProps, BaseProps {
  /**
   * Allows you to add `UnaUI` avatar preset properties,
   * Think of it as a shortcut for adding options or variants to the preset if available.
   *
   * @see https://github.com/una-ui/una-ui/blob/main/packages/preset/src/_shortcuts/avatar.ts
   * @example
   * avatar="solid-green"
   */
  avatar?: HTMLAttributes['class']

  una?: Pick<NAvatarUnaProps, 'avatarRoot'>
}

export interface NAvatarAvatarFallbackProps extends AvatarFallbackProps, BaseProps {
  /**
   * Add a label to the fallback.
   */
  label?: string
  /**
   * Convert `label` prop to icon component.
   *
   * @default false
   * @example
   * icon
   * label="i-lucide-user"
   */
  icon?: boolean

  una?: Pick<NAvatarUnaProps, 'avatarFallback' | 'avatarLabel' | 'avatarIcon'>
}

export interface NAvatarImageProps extends Omit<AvatarImageProps, 'src'>, BaseProps {
  src?: string
  alt?: string
  una?: Pick<NAvatarUnaProps, 'avatarImage'>
}

export interface NAvatarUnaProps {
  avatarRoot?: HTMLAttributes['class']
  avatarImage?: HTMLAttributes['class']
  avatarFallback?: HTMLAttributes['class']

  avatarLabel?: HTMLAttributes['class']
  avatarIcon?: HTMLAttributes['class']
}

Components

Avatar.vue

AvatarFallback.vue

AvatarImage.vue

<script setup lang="ts">
import type { NAvatarProps } from '../../../types'
import { AvatarRoot } from 'reka-ui'
import { cn } from '../../../utils'
import AvatarFallback from './AvatarFallback.vue'
import AvatarImage from './AvatarImage.vue'

defineOptions({
  inheritAttrs: false,
})

const props = withDefaults(defineProps<NAvatarProps>(), {
  as: 'span',
  size: 'md',
  rounded: 'full',
  square: '2.5em',
  avatar: 'soft',
})
</script>

<template>
  <AvatarRoot
    :class="cn(
      'avatar',
      una?.avatarRoot,
      props.class,
    )"
    :size
    :rounded
    :square
    :avatar
    v-bind="{ ..._avatarRoot, ...$attrs }"
  >
    <slot>
      <AvatarImage
        v-if="src"
        :src
        :una
        :alt
        v-bind="_avatarImage"
      />
    </slot>

    <AvatarFallback
      :label="label || alt?.split(' ').map(word => word[0]).join('').slice(0, 2)"
      :icon
      v-bind="_avatarFallback"
      :una
    >
      <slot name="fallback" />
    </AvatarFallback>
  </AvatarRoot>
</template>