Skip to content

role presentation

Avatar draft v0.1.0

Represents a person or an entity with a picture, or their initials when there is none.

An avatar shows who or what something belongs to: the author of a comment, the members of a project, a workspace. It displays a picture when there is one and the initials of the name otherwise, in a circle or a rounded square. Assistive technology reads it as an image named by the person, unless the name is written right next to it, in which case the avatar is decoration.

Guidelines

From apps/docs/content/components/avatar.md

Overview

An avatar shows who or what something belongs to: the author of a comment, the members of a project, a workspace. It displays a picture when there is one and the initials of the name otherwise, in a circle for people or a rounded square for entities. Assistive technology reads it as an image named by the person, unless the name is written right next to it, in which case the avatar is decoration.

This page applies to every platform. Where a platform differs, the difference sits under a sub-heading named after it (Web, iOS, Android, Desktop); everything else holds everywhere.

When to use

  • Identifying the author or owner of something: comments, assignments, activity.
  • Representing a member, a team or a workspace in lists and headers.

When not to use

  • Illustration or product images. An avatar is an identity, not a picture.
  • Status alone. A presence dot or a badge is another part, not specified here.

Sizes and shapes

Size Use for
Small Lists and comments: 24 px.
Medium Most places, the default: 32 px.
Large Profile headers and cards: 40 px.

Circle for people, square for entities (teams, organizations, bots).

Name and picture

The name is the full name as the person wrote it; it is the accessible name of the avatar and the source of the initials (first letters of the first and last words). The picture, when given, covers the whole shape. When the name is written next to the avatar, mark the avatar decorative so the name is not read twice.

Accessibility

The Specification tab lists the full accessibility contract. Each statement there links the source it comes from. This section explains the decisions behind it.

Web

iOS

  • Provide alternative text labels for custom interface images so VoiceOver can describe them (Apple HIG: Icons).

Android

  • Icon (a glyph, named or decorative)
  • Badge (a status next to an item)