Skip to content
Design System
GitHub

Avatar

v0.17.3

A person (round) or a robot, site or team (square), by picture, initials or icon, in four sizes, with a status or count badge and overlapping groups that fold into +N.

MLMLMLML

Avatar default

Install
npx shadcn add @syncrobotic/avatar

Also installs: radix-ui, @syncrobotic/cn, @syncrobotic/status-glyph

Overview

A person's picture or initials, round; a robot, site or team, square. With a status or count badge, and groups that fold into +N.

When to use

  • The signed-in user, an assignee, an author in a log.
  • A robot or site next to its name in a list.
  • Who is on shift, or which robots share a route, as a group.

Use something else

  • A robot's live state in a table: Status glyph and inline-status, not a badge on an avatar.
  • A large icon in a coloured tile: Icon tile.

More examples

States and real uses. Each example is also a Storybook story and a visual regression test.

  • MLMei LinOperator
  • Patrol dog 7F3ARobot · Hall B
  • NSNorth siteSite · 14 robots

Avatar people and robots

  • MLMei LinOn shift
  • ARArjun RaoAway
  • SKSara KimShift ends in 10 min
  • TWTom WuOff shift

Avatar status

Patrol dog 7F3A3 open alarms

Avatar count

MLARSK+2
5 on shift
7F2B4C9C+4
8 robots on this route

Avatar group overflow

MLMei LinPicture not available: initials instead

Avatar image fallback

Usage rules

  • A person or a robot, by picture or initials. Initials when there is no picture, never an empty circle.
  • People are round; robots, sites and teams are square (shape="square"), so a mixed list tells who from what before the name is read.
  • Pair it with the name: an avatar alone is not an identity. A status badge is said in words too, nearby or in the label.
  • A group shows a few and folds the rest into +N (max); its label names everyone.

Changelog

  • 0.17.32026-11-19Fallback on --track with foreground initials; groups overlap less so initials are whole.
  • 0.15.02026-11-19size (sm 24, md 32, lg 40, xl 48) and shape (circle for people, square for robots, sites and teams); AvatarBadge for a status (StatusGlyph shapes) or a count; AvatarGroup with max folding the rest into +N and a label for screen readers; AvatarGroupCount. The default looks as before. With an aria-label it is announced as one picture (role="img").
  • 0.5.02026-11-17First versioned release. Earlier history is in CHANGELOG.md.

How to upgrade