Skip to main contentPrimer

GitHubAvatar

Optimized avatar component that loads smaller images based on the configured size

Internal Component

This component is intended solely for use within GitHub and is not available for external use.
React
draft
Docs|Storybook|Source

Props

GitHubAvatar

NameDefaultDescription
size
any

Sets the width and height of the avatar.

square
boolean

Sets the shape of the avatar to a square if true. If false, the avatar will be circular.

src Required
string

URL of the avatar image.

alt
string

Provide alt text when the Avatar is used without the user's name next to it.

className
string

Additional class name.