2017-05-28 14:20:59 +08:00
|
|
|
---
|
|
|
|
|
category: Components
|
|
|
|
|
type: Data Display
|
|
|
|
|
title: Avatar
|
2020-05-31 11:48:34 +08:00
|
|
|
cover: https://gw.alipayobjects.com/zos/antfincdn/aBcnbw68hP/Avatar.svg
|
2017-05-28 14:20:59 +08:00
|
|
|
---
|
|
|
|
|
|
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
|
|
|
|
|
|
2020-07-13 12:45:37 +08:00
|
|
|
### Avatar
|
|
|
|
|
|
2019-07-11 14:14:33 +08:00
|
|
|
| Property | Description | Type | Default | Version |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
2020-10-21 10:33:43 +08:00
|
|
|
| alt | This attribute defines the alternative text describing the image | string | - | |
|
|
|
|
|
| gap | Letter type unit distance between left and right sides | number | 4 | 4.3.0 |
|
2020-07-01 21:35:29 +08:00
|
|
|
| icon | Custom icon type for an icon avatar | ReactNode | - | |
|
|
|
|
|
| shape | The shape of avatar | `circle` \| `square` | `circle` | |
|
2020-11-02 11:31:42 +08:00
|
|
|
| size | The size of the avatar | number \| `large` \| `small` \| `default` \| { xs: number, sm: number, ...} | `default` | 4.7.0 |
|
|
|
|
|
| src | The address of the image for an image avatar or image element | string \| ReactNode | - | ReactNode: 4.8.0 |
|
2020-07-01 21:35:29 +08:00
|
|
|
| srcSet | A list of sources to use for different screen resolutions | string | - | |
|
|
|
|
|
| onError | Handler when img load error, return false to prevent default fallback behavior | () => boolean | - | |
|
2020-06-12 15:26:40 +08:00
|
|
|
|
|
|
|
|
> Tip: You can set `icon` or `children` as the fallback for image load error, with the priority of `icon` > `children`
|
2020-07-13 12:45:37 +08:00
|
|
|
|
|
|
|
|
### Avatar.Group (4.5.0+)
|
|
|
|
|
|
2020-10-21 10:33:43 +08:00
|
|
|
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
|
|
|
|
| --- | --- | --- | --- | --- |
|
|
|
|
|
| maxCount | Max avatars to show | number | - | |
|
|
|
|
|
| maxPopoverPlacement | The placement of excess avatar Popover | `top` \| `bottom` | `top` | |
|
|
|
|
|
| maxStyle | The style of excess avatar style | CSSProperties | - | |
|
2020-10-24 22:00:43 +08:00
|
|
|
| size | The size of the avatar | number \| `large` \| `small` \| `default` \| { xs: number, sm: number, ...} | `default` | 4.8.0 |
|
