2017-05-28 14:20:59 +08:00
|
|
|
---
|
|
|
|
|
category: Components
|
|
|
|
|
type: Data Display
|
|
|
|
|
title: Avatar
|
|
|
|
|
---
|
|
|
|
|
|
2017-09-16 11:29:51 +08:00
|
|
|
Avatars can be used to represent people or objects. It supports images, `Icon`s, or letters.
|
2017-05-28 14:20:59 +08:00
|
|
|
|
|
|
|
|
## API
|
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
| Property | Description | Type | Default | Version |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
2019-10-23 15:52:08 +08:00
|
|
|
| icon | the `Icon` type for an icon avatar, see `Icon` Component or use ReactNode | string \| ReactNode | - | |
|
2019-07-11 14:14:33 +08:00
|
|
|
| shape | the shape of avatar | `circle` \| `square` | `circle` | |
|
|
|
|
|
| size | the size of the avatar | number \| string: `large` `small` `default` | `default` | |
|
|
|
|
|
| src | the address of the image for an image avatar | string | - | |
|
|
|
|
|
| srcSet | a list of sources to use for different screen resolutions | string | - | 3.11.0 |
|
|
|
|
|
| alt | This attribute defines the alternative text describing the image | string | - | 3.7.0 |
|
|
|
|
|
| onError | handler when img load error, return false to prevent default fallback behavior | () => boolean | - | 3.8.0 |
|
