Component

Avatar

Represents a user or entity with an image, initials, or fallback content.

Install

Run the CLI to copy the source into your project.

pnpm dlx @stalk-ui/cli add @stalk-ui/avatar

Examples

Live previews render through the docs app's PandaCSS codegen.

Theme
<Avatar name="Ada Lovelace" />
Theme
<Avatar
  src="https://images.unsplash.com/photo-1535713875002-d1d0cf377fde?w=128&h=128&fit=crop"
  name="Ada Lovelace"
  size="lg"
/>
Theme
<Avatar name="Linus Torvalds" tone="success" radius="md" />

Props

Public component props extracted from the source TypeScript types.

PropTypeRequiredDefaultDescription
`src``string`No-Image source. When omitted or fails to load, falls back to initials / \`fallback\`.
`alt``string`No-Alt text for the image; also used to derive initials when \`name\` is not set.
`name``string`No-Name used to derive 2-letter initials. Falls back to \`alt\`.
`fallback``ReactNode`No-Custom fallback content (icon, custom initials, etc.). Overrides derived initials.
`fallbackDelay``number`No-Delay (ms) before showing the fallback while the image loads. Defaults to 600.
`loading``'eager' \'lazy'`No-
`onLoadingStatusChange``AvatarImageProps['onLoadingStatusChange']`No-Called when the image's loading state changes.
PropTypeRequiredDefaultDescription
`size``AvatarSize`No-Match the size on the parent \`AvatarRoot\` so fallback text scales correctly.
PropTypeRequiredDefaultDescription
`radius``AvatarRadius`No--
`size``AvatarSize`No--
`tone``AvatarTone`No-Selects the semantic color palette used as the fallback background.

Variants

Variant axes exposed by the underlying PandaCSS recipe or slot recipe.

VariantValues
`size``xs`, `sm`, `md`, `lg`, `xl`, `2xl`
`radius``none`, `sm`, `md`, `lg`, `full`

Registry

Files this component contributes to your registry install.

  • Manifest: `/r/avatar.json`
  • Recipe: `avatar`
  • Files: `src/components/ui/avatar.tsx`