mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-12-13 23:59:12 +08:00
Code Issues Actions 18 Packages Projects Releases Wiki Activity
1e9b90c599
ant-design/components/avatar/index.en-US.md

1.7 KiB
Raw Blame History

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
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
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 or image element string | ReactNode - ReactNode: 4.8.0
srcSet A list of sources to use for different screen resolutions string -
draggable Whether the picture is allowed to be dragged boolean | 'true' | 'false' -
onError Handler when img load error, return false to prevent default fallback behavior () => boolean -

Tip: You can set icon or children as the fallback for image load error, with the priority of icon > children

Avatar.Group (4.5.0+)

Property Description Type Default Version
maxCount Max avatars to show number -
maxPopoverPlacement The placement of excess avatar Popover top | bottom top
maxStyle The style of excess avatar style CSSProperties -
size The size of the avatar number | large | small | default | { xs: number, sm: number, ...} default 4.8.0