mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-12-03 00:09:39 +08:00
Code Issues Actions 29 Packages Projects Releases Wiki Activity
65063943f0
ant-design/components/avatar/index.en-US.md
二货爱吃白萝卜 20561d6f9d
docs: Fix component doc alignment & support import usage (#48004) 
* docs: init ref

* docs all support

* docs: fix link show
2024-03-22 14:22:42 +08:00

2.9 KiB
Raw Blame History

category title description cover coverDark demo group
Components Avatar Used to represent users or things, supporting the display of images, icons, or characters. https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*JJBSS5lBG4IAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*YbgyQaRGz-UAAAAAAAAAAAAADrJ8AQ/original
cols
2
title order
Data Display 5

Examples

Basic Type Autoset Font Size With Badge Avatar.Group Calculate text style when hiding Responsive Size Fallback Component Token

API

Common props ref：Common props

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' true
crossOrigin CORS settings attributes 'anonymous' | 'use-credentials' | '' - 4.17.0
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
maxPopoverTrigger Set the trigger of excess avatar Popover hover | focus | click hover 4.17.0
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
shape The shape of the avatar circle | square circle 5.8.0

Design Token