Skip to content
Components
AvatarAvatarStackBorderBoxBoxBranchNameBreadcrumbsButtonsCircleBadgeCircleOcticonCounterLabelDetailsDialogDropdownFilteredSearchFilterListFlashFlexFormGroupGridHeaderHeadingLabelLabelGroupLinkPageheadPaginationPointerBoxPopoverPositionProgressBarSelectMenuSideNavStateLabelStyledOcticonSubNavTabNavTextTextInputTimelineTooltipTruncateUnderlineNav
Avatar
Table of contents
Table of contents
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
AvatarPair
System props
Avatar components get COMMON system props. Read our System Props doc page for a full list of available props.
Component props
| Name | Type | Default | Description |
|---|---|---|---|
| alt | String | Passed through to alt on img tag | |
| size | Number | 20 | adds the avatar-small class if less than 24 |
| src | String | The source url of the avatar image | |
| square | Boolean | false | Used to create a square avatar |
Edit this page on GitHub
3 contributors
Last edited by emplums on June 24, 2020