mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-04 13:08:41 +08:00
9101f3666a
fix lint and test failures update avatar demo card title update ts type check for undefined
1.7 KiB
1.7 KiB
| category | type | title | cover |
|---|---|---|---|
| Components | Data Display | Avatar | https://gw.alipayobjects.com/zos/antfincdn/aBcnbw68hP/Avatar.svg |
Avatars can be used to represent people or objects. It supports images, Icons, or letters.
API
Avatar
| Property | Description | Type | Default | Version |
|---|---|---|---|---|
| icon | Custom icon type for an icon avatar | ReactNode | - | |
| shape | The shape of avatar | circle | square |
circle |
|
| 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 | string | - | |
| srcSet | A list of sources to use for different screen resolutions | string | - | |
| alt | This attribute defines the alternative text describing the image | string | - | |
| onError | Handler when img load error, return false to prevent default fallback behavior | () => boolean | - | |
| gap | Letter type unit distance between left and right sides | number | 4 | 4.3.0 |
Tip: You can set
iconorchildrenas the fallback for image load error, with the priority oficon>children
Avatar.Group (4.5.0+)
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| maxCount | Max avatars to show | number | - | |
| maxStyle | The style of excess avatar style | CSSProperties | - | |
| maxPopoverPlacement | The placement of excess avatar Popover | top | bottom |
top |