Skip to content


Avatars are images used to represent users and organizations on GitHub. Use the default round avatar for users, and the square prop for organizations or any other non-human avatars.

Default example

Square Avatar


System props

Avatar components get COMMON system props. Read our System Props doc page for a full list of available props.

Component props

altStringPassed through to alt on img tag
sizeNumber20adds the avatar-small class if less than 24
srcStringThe source url of the avatar image
squareBooleanfalseUsed to create a square avatar
Edit this page on GitHub
3 contributorsemplumsashygeealbingroen
Last edited by emplums on June 24, 2020