Skip to main content
Version: Next

AvatarProps

Home > @backstage/ui > AvatarProps

Signature:

export interface AvatarProps extends React.ComponentPropsWithoutRef<'div'> 

Extends: React.ComponentPropsWithoutRef<'div'>

Properties

Property

Modifiers

Type

Description

name

string

Name of the person - used for generating initials and accessibility labels

purpose?

'decoration' | 'informative'

(Optional) Determines how the avatar is presented to assistive technologies. - 'informative': Avatar is announced as "{name}" to screen readers - 'decoration': Avatar is hidden from screen readers (use when name appears in adjacent text)

size?

'x-small' | 'small' | 'medium' | 'large' | 'x-large'

(Optional) Size of the avatar

src

string

URL of the image to display