Avatar

Use the avatar component to display a thumbnail representation of a person.

Ready to use
import {Avatar, Stack} from '@primer/react-brand'

Examples

Default

Loading

Sizes

The size of the avatar can be controlled by the size prop.

Loading

Responsive Sizes

Passing an Object of a particular shape will allow granular control of size at various supported breakpoints.

Supported breakpoints are narrow, regular and wide.

The Object value does not require all properties be passed, but rather operates on the basis of min-width.

E.g. Providing only narrow will apply that value to all larger breakpoints, but not the other way.

Loading

Shapes

The shape of the avatar can be controlled by the shape prop.

Loading

Component props

Avatar Required

nametypedefaultrequireddescription
altstringtrueThe alt text of the image
classNamestringfalseAvatar custom class
size 32, 40, 48, 64, 8040falseThe size (in pixels) of the image
shape'circle', 'square'circlefalseThe shape of the image
srcstringtrueA url to the person’s image