@eds/avatar
v4.1.4
Avatar
A visual representation of a user.Prop | Required | Description | Type |
|---|---|---|---|
name | — | Used for the image's alt attribute, and for the name initials when there is no image (src) provided. | string |
size | — | The size of the avatar. Defaults to medium. | "xsmall" | "small" | "medium" | "large" | "xlarge"Supports responsive prop syntax |
disabled | — | Optionally set the avatar as disabled. | boolean |
src | — | Optionally set the avatar image. | string |
Prop | Required | Description | Type |
|---|---|---|---|
children | ✅ | Pass in <Avatar />s as children. | ReactElement<AvatarProps, string | JSXElementConstructor<any>>[] |
size | — | The size of the avatar within the group. Defaults to medium. | "xsmall" | "small" | "medium" | "large" | "xlarge"Supports responsive prop syntax |
cap | — | Max number of avatars to be displayed. | number |