Avatar

Avatar is an image that represents a user or organization.

React
readyNot reviewed for a11y
Rails
readyNot reviewed for a11y

Use Avatars to represent users, organizations, bots, or teams. On GitHub, Avatars are either rounded squares or circles.

React examples

Default

Mona user avatar

Custom size

Avatars start at 16px and increment by base-4 until 32px. At 32px, the scale switches to base-8 up to 48px. 64px is the largest size in this scale.

Mona user avatar

Square shape

Avatars appear as two different shapes, each with their own functional purpose.

  • Circle Avatars represent individual people.
  • Square Avatars represent non-human entities, such as bots, teams, or organizations

Shape guidelines

Mona user avatar

More code examples

See the Avatar Storybook stories.

Props

Avatar

NameRequiredDescription
alt
string
Provide alt text when the avatar is used without a name next to it.
size
number | { narrow?: number; regular?: number; wide?: number; }
The size of the avatar in pixels.
square
boolean
If true, the avatar will be square instead of circular.
src
string
URL of the avatar image.
sx
SystemStyleObject