Avatar
Avatar is an image that represents a user or organization.
On this page
v0.25.1BetaNot reviewed for accessibility
Description
Avatar can be used to represent users and organizations on GitHub.
- Use the default circle avatar for users, and the square shape for organizations or any other non-human avatars.
- By default,
Avatarwill render a static<img>. To haveAvatarfunction as a link, set thehrefwhich will wrap the<img>in a<a>. - Set
sizeto update the height and width of theAvatarin pixels. - To stack multiple avatars together, use AvatarStack.
Accessibility
Images should have text alternatives that describe the information or function represented.
If the avatar functions as a link, provide alt text that helps convey the function. For instance,
if Avatar is a link to a user profile, the alt attribute should be @kittenuser profile
rather than @kittenuser.
Learn more about best image practices (WAI Images)
Arguments
| Name | Default | Description |
|---|---|---|
src | N/A | StringThe source url of the avatar image. |
alt |
| StringPassed through to alt on img tag. |
size |
| IntegerOne of |
shape |
| SymbolShape of the avatar. One of |
href |
| StringThe URL to link to. If used, component will be wrapped by an |
system_arguments | N/A | Hash |