Skip to content

Avatar group

Overlapping avatars with an overflow count and a single accessible name for the whole set.

Datastarteravatarteamoverflowgroup

Live preview

full widthLive preview — open it in a new tab for the full-height version.
Open the preview in a new tab

Source

The exact file rendered in the preview above.

import { AvatarGroup } from '@/components/ui/avatar'
import { Card, CardDescription, CardTitle } from '@/components/ui/card'
import { DemoRow, DemoStage } from './_kit'

const team = [
  'Priya Raman',
  'Tomas Lindqvist',
  'Amara Osei',
  'Jun Watanabe',
  'Elena Rossi',
  'Marcus Bell',
  'Sofia Delgado',
]

export default function AvatarGroupDemo() {
  return (
    <DemoStage>
      <DemoRow label="Overflow" description="Names beyond the maximum collapse into a count.">
        <AvatarGroup names={team} label="Platform team" />
        <AvatarGroup names={team} max={2} label="Platform team, short" />
        <AvatarGroup names={team.slice(0, 3)} label="Design team" />
      </DemoRow>

      <DemoRow label="Sizes">
        <AvatarGroup names={team.slice(0, 4)} size="xs" label="Extra small group" />
        <AvatarGroup names={team.slice(0, 4)} size="sm" label="Small group" />
        <AvatarGroup names={team.slice(0, 4)} size="md" label="Medium group" />
      </DemoRow>

      <DemoRow label="In context">
        <Card className="w-full max-w-sm">
          <CardTitle>Platform</CardTitle>
          <CardDescription className="mt-1">Owns the deployment pipeline.</CardDescription>
          <div className="mt-4 flex items-center justify-between">
            <AvatarGroup names={team} max={5} label="Platform team members" />
            <span className="text-xs text-ink-muted">{team.length} members</span>
          </div>
        </Card>
      </DemoRow>
    </DemoStage>
  )
}

components/demos/avatar-group.tsx

import { AvatarGroup } from '@/components/ui/avatar'
import { Card, CardDescription, CardTitle } from '@/components/ui/card'
import { DemoRow, DemoStage } from './_kit'

const team = [
  'Priya Raman',
  'Tomas Lindqvist',
  'Amara Osei',
  'Jun Watanabe',
  'Elena Rossi',
  'Marcus Bell',
  'Sofia Delgado',
]

export default function AvatarGroupDemo() {
  return (
    <DemoStage>
      <DemoRow label="Overflow" description="Names beyond the maximum collapse into a count.">
        <AvatarGroup names={team} label="Platform team" />
        <AvatarGroup names={team} max={2} label="Platform team, short" />
        <AvatarGroup names={team.slice(0, 3)} label="Design team" />
      </DemoRow>

      <DemoRow label="Sizes">
        <AvatarGroup names={team.slice(0, 4)} size="xs" label="Extra small group" />
        <AvatarGroup names={team.slice(0, 4)} size="sm" label="Small group" />
        <AvatarGroup names={team.slice(0, 4)} size="md" label="Medium group" />
      </DemoRow>

      <DemoRow label="In context">
        <Card className="w-full max-w-sm">
          <CardTitle>Platform</CardTitle>
          <CardDescription className="mt-1">Owns the deployment pipeline.</CardDescription>
          <div className="mt-4 flex items-center justify-between">
            <AvatarGroup names={team} max={5} label="Platform team members" />
            <span className="text-xs text-ink-muted">{team.length} members</span>
          </div>
        </Card>
      </DemoRow>
    </DemoStage>
  )
}

components/ui/avatar.tsx

import type { ReactNode } from 'react'
import { cn } from '@/lib/cn'
import { initials as toInitials } from '@/lib/format'

/**
 * Avatar / AvatarGroup
 *
 * Foundry ships no photography, so avatars render deterministic initials on a
 * tinted surface. The tint is derived from the name's character codes, which
 * keeps the same person the same colour on every page without a colour field
 * in the data.
 *
 * A decorative avatar next to a visible name is `aria-hidden`; a standalone
 * one exposes the name as its label.
 */
export interface AvatarProps {
  name: string
  size?: 'xs' | 'sm' | 'md' | 'lg' | 'xl'
  /** Suppresses the accessible name when the name is already on screen. */
  decorative?: boolean
  /** Small badge anchored bottom-right, e.g. a presence dot. */
  indicator?: ReactNode
  shape?: 'circle' | 'square'
  className?: string
}

const sizes = {
  xs: 'size-5 text-2xs',
  sm: 'size-7 text-2xs',
  md: 'size-9 text-xs',
  lg: 'size-12 text-sm',
  xl: 'size-16 text-lg',
} as const

const tints = [
  'bg-accent-soft text-accent-soft-ink',
  'bg-success-soft text-success',
  'bg-warning-soft text-warning',
  'bg-info-soft text-info',
  'bg-danger-soft text-danger',
  'bg-surface-sunken text-ink-muted',
] as const

function tintFor(name: string): string {
  let hash = 0
  for (let i = 0; i < name.length; i += 1) hash = (hash * 31 + name.charCodeAt(i)) % 997
  return tints[hash % tints.length] ?? tints[0]
}

export function Avatar({
  name,
  size = 'md',
  decorative = false,
  indicator,
  shape = 'circle',
  className,
}: AvatarProps) {
  return (
    <span className={cn('relative inline-flex shrink-0', className)}>
      <span
        role={decorative ? undefined : 'img'}
        aria-label={decorative ? undefined : name}
        aria-hidden={decorative || undefined}
        className={cn(
          'inline-flex items-center justify-center border border-line font-semibold select-none',
          shape === 'circle' ? 'rounded-full' : 'rounded-md',
          sizes[size],
          tintFor(name),
        )}
      >
        {toInitials(name)}
      </span>
      {indicator ? <span className="absolute -right-0.5 -bottom-0.5">{indicator}</span> : null}
    </span>
  )
}

export interface AvatarGroupProps {
  names: string[]
  size?: AvatarProps['size']
  /** Names beyond this count collapse into a "+n" chip. */
  max?: number
  className?: string
  label?: string
}

export function AvatarGroup({ names, size = 'sm', max = 4, className, label }: AvatarGroupProps) {
  const visible = names.slice(0, max)
  const overflow = names.length - visible.length

  return (
    <span
      className={cn('flex items-center', className)}
      role="group"
      aria-label={label ?? `${names.length} people`}
    >
      {visible.map((name) => (
        <span
          key={name}
          className="-ml-2 first:ml-0 ring-2 ring-[var(--color-surface)] rounded-full"
        >
          <Avatar name={name} size={size} decorative />
        </span>
      ))}
      {overflow > 0 ? (
        <span
          className={cn(
            '-ml-2 inline-flex items-center justify-center rounded-full border border-line bg-surface-sunken font-semibold text-ink-muted ring-2 ring-[var(--color-surface)]',
            sizes[size],
          )}
        >
          +{overflow}
        </span>
      ) : null}
      <span className="sr-only">{names.join(', ')}</span>
    </span>
  )
}

Demo source — adapt to your project. Foundry is not published as a package.

Usage

For showing membership at a glance — a team, a set of reviewers, attendees. The overflow chip keeps the control a fixed width no matter how large the group grows.

  • Every avatar in the group is decorative; the group carries one label and a visually hidden full list.
  • Pair with a total count in text when the exact number matters.

Variants and states

Every entry below is a genuine difference in behaviour or layout, and every one of them is visible in the preview above.

  • Default maximum of four
  • Custom maximum
  • Three sizes

Accessibility

Single announcement
A labelled `role="group"` plus a visually hidden comma-separated list, so a screen reader reads the members once, in order.
Overflow chip
The +n chip is inside the labelled group, so the total is announced with the members.

Foundry implements published ARIA patterns and is tested against them. No WCAG certification is claimed — see the accessibility documentation for what is and is not covered.