

<InteractiveDemo
  name="avatar"
  controls="[
  {
    type: 'string',
    name: 'src',
    defaultValue: 'https://github.com/mehdibha.png',
  },
  {
    type: 'string',
    name: 'fallback',
    defaultValue: 'M',
  },
  {
    type: 'enum',
    name: 'size',
    options: ['sm', 'md', 'lg'],
    defaultValue: 'md',
  },
]"
/>

## Installation [#installation]

<CodeBlockTabs defaultValue="npm">
  <CodeBlockTabsList>
    <CodeBlockTabsTrigger value="npm">
      npm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="pnpm">
      pnpm
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="yarn">
      yarn
    </CodeBlockTabsTrigger>

    <CodeBlockTabsTrigger value="bun">
      bun
    </CodeBlockTabsTrigger>
  </CodeBlockTabsList>

  <CodeBlockTab value="npm">
    ```bash
    npx shadcn@latest add @dotui/avatar
    ```
  </CodeBlockTab>

  <CodeBlockTab value="pnpm">
    ```bash
    pnpm dlx shadcn@latest add @dotui/avatar
    ```
  </CodeBlockTab>

  <CodeBlockTab value="yarn">
    ```bash
    yarn dlx shadcn@latest add @dotui/avatar
    ```
  </CodeBlockTab>

  <CodeBlockTab value="bun">
    ```bash
    bun x shadcn@latest add @dotui/avatar
    ```
  </CodeBlockTab>
</CodeBlockTabs>

## Usage [#usage]

Use avatars to represent users or entities with an image or initials.

```tsx
import { Avatar, AvatarImage, AvatarFallback } from '@/components/ui/avatar'
```

```tsx
<Avatar>
  <AvatarImage src="https://github.com/mehdibha.png" alt="@mehdibha" />
  <AvatarFallback>MB</AvatarFallback>
</Avatar>
```

## Examples [#examples]

<Examples className="grid-cols-2 sm:grid-cols-3">
  <Example name="avatar/demos/basic" title="Basic" />

  <Example name="avatar/demos/fallback-only" title="Fallback-only" />

  <Example name="avatar/demos/sizes" title="Sizes" />

  <Example name="avatar/demos/radii" title="Radii" />

  <Example name="avatar/demos/badge" title="Badge" />

  <Example name="avatar/demos/badge-with-icon" title="Badge with icon" />

  <Example name="avatar/demos/badge-top-right" title="Status badge" />

  <Example name="avatar/demos/badge-notification" title="Badge with notification" />

  <Example name="avatar/demos/icon-fallback" title="Icon fallback" />

  <Example name="avatar/demos/group" title="Group" />

  <Example name="avatar/demos/avatar-group-count" title="Group with count" />
</Examples>

## API Reference [#api-reference]

### Avatar [#avatar]

<Reference name="avatar" />

### AvatarImage [#avatarimage]

<Reference name="avatar-image" />

### AvatarFallback [#avatarfallback]

<Reference name="avatar-fallback" />

### AvatarBadge [#avatarbadge]

<Reference name="avatar-badge" />

### AvatarGroup [#avatargroup]

<Reference name="avatar-group" />

### AvatarGroupCount [#avatargroupcount]

<Reference name="avatar-group-count" />
