preskok/ui

User avatar component with images or initials, sizes, and square/round styles.

Installation

pnpm dlx @preskok-org/ui@latest add avatar

Usage

import { Avatar } from "@/registry/preskok/ui/preskok-ui/avatar"
 
export function AvatarDemo() {
  return (
    <div className="flex gap-4">
      <Avatar src="/avatars/01.png" alt="Alex Johnson" />
      <Avatar initials="AJ" alt="Alex Johnson" />
      <Avatar initials="JR" alt="Jamie Rivera" isSquare size="lg" />
    </div>
  )
}

Props

PropTypeDefaultDescription
srcstring | nullnullImage source
initialsstring-Initials fallback
altstring""Accessible alt text
isSquarebooleanfalseSquare vs. circular shape
size"xs" | "sm" | "md" | "lg" | "xl""md"Avatar size
classNamestring-Additional CSS classes