Skip to content

Avatars

  • Stable
  • Not reviewed for accessibility

Avatars are images that users can set as their profile picture. On GitHub, they're always going to be rounded squares. They can be custom photos, uploaded by users, or generated as Identicons as a placeholder.

Basic example

Add .avatar to any <img> element to make it an avatar. This resets some key styles for alignment, address a Firefox image placeholder bug, and rounds the corners.

Be sure to set width and height attributes for maximum browser performance.

Small avatars

We occasionally use smaller avatars. Anything less than 24px wide should include the .avatar-small modifier class to reset the border-radius to a more appropriate level.

Avatar sizes

Instead of using the width and height attribute, you can also use a class like .avatar-[1-8]. The sizes go from 16px up to 64px. Note: Avatar stacks are only supported for the 20px avatar size.

Parent-child avatars

When you need a larger parent avatar, and a smaller child one, overlaid slightly, use the parent-child classes.

Circle badge

.CircleBadge allows for the display of badge-like icons or logos. They are used mostly with Octicons or partner integration icons.

.CircleBadge should have an aria-label, title (for a link), or an alt (for child img elements) attribute specified if there is no text-based alternative to describe it. If there is a text-based alternative or the icon has no semantic value, aria-hidden="true" or an empty alt attribute may be used.

Small

Medium

Large

Dashed connection

For specific cases where two badges or more need to be shown as related or connected (such as integrations or specific product workflows), a DashedConnection class was created. Use utility classes to ensure badges are spaced correctly.