Skip to content

Avatar

Alpha
Use avatars to represent users or organizations.
import {Avatar} from '@primer/react'

Examples

Default

Square

Props

Avatar

NameTypeDefaultDescription
src Required
string
URL of the avatar image.
alt
string
''Provide alt text when the avatar is used without a name next to it.
size
number
20The size of the avatar in pixels.
square
boolean
falseIf true, the avatar will be square instead of circular.
sx
SystemStyleObject
Style overrides to apply to the component. See also overriding styles.

Status

Alpha

  • Component props are documented on primer.style/react.
  • Component does not have any unnecessary third-party dependencies.
  • Component can adapt to different themes.
  • Component can adapt to different screen sizes.
  • Component has 100% test coverage.

Beta

  • Component is used in a production application.
  • Common usage examples are documented on primer.style/react.
  • Common usage examples are documented in storybook stories.
  • Component has been reviewed by a systems designer and any resulting issues have been addressed.
  • Component has been manually reviewed by the accessibility team and any resulting issues have been addressed.

Stable

  • Component API has been stable with no breaking changes for at least one month.
  • Feedback on API usability has been sought from developers using the component and any resulting issues have been addressed.
  • Component has corresponding design guidelines documented in the interface guidelines.
  • Component has corresponding Figma component in the Primer Web library.
Edit this page on GitHub
3 contributorscolebemisashygeealbingroen
Last edited by colebemis on December 8, 2021