Skip to content
GaudiGaudi Design System home

Search documentation

Search every page, heading and paragraph.

Avatar

Profile images, resilient initials, presence, verification, account menus and collaborator groups.

CoreBasics@gaudi/design-system/core/AvatarView in StorybookSource

The existing Avatar API and curated patterns share the same image and fallback primitives.

Installation

pnpm add github:ahmadassaf/design-system

Import from @gaudi/design-system. Load @gaudi/design-system/global.css once and add transpilePackages: ['@gaudi/design-system'] in Next.js.

import { Avatar } from '@gaudi/design-system/core/Avatar';

Copy an example into your project with the shadcn CLI: npx shadcn@latest add https://design.gaudi.site/r/avatar-account-menu.json.

Usage

import { Avatar } from '@gaudi/design-system';
<Avatar name='Mei Castellanos' src='/avatars/person-20.svg' shape='circle' indicator={{ label: 'Online', tone: 'success' }} />

Playground

Avatar props
Props
default md
default square
default solid
default gray
Avatar.jsx
import { Avatar } from '@gaudi/design-system/core/Avatar';
<Avatar name='Ada Lovelace' />

Examples

Account dropdown menu

Storybook

Rings and activity

Storybook

Empty state

Storybook

Groups

Storybook

Hover groups with tooltips

Storybook

Inside buttons

Storybook

Sizes, shapes and fallbacks

Storybook

Social proof

Storybook

Status and icon badges

Storybook

User details and badge

Storybook

API

15 props

Accessibility

A named Avatar exposes one image label, including host-provided presence. Use alt="" beside visible identity text. Wrap interactive avatars in Button, Tooltip or DropdownMenu; status badges never infer presence from image loading.