ant-design-vue/index.en-US.md at 058bc3622a275d4eee7898158a6f467cb34cfe19

mirror of https://gitee.com/ant-design-vue/ant-design-vue.git synced 2024-12-06 05:59:46 +08:00

* 更改Badge组件文档text属性说明

* 更改Avatar组件文档crossOrigin属性说明

Co-authored-by: 吴亚丹 <wuyadan@uniontech.com>

2022-10-21 14:38:57 +08:00

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

Property	Description	Type	Default	Version
alt	This attribute defines the alternative text describing the image	string	-
crossOrigin	cors settings attributes	`'anonymous'` \| `'use-credentials'` \| `''`	-	3.0
draggable	Whether the picture is allowed to be dragged	boolean \| `'true'` \| `'false'`	-	2.2.0
gap	Letter type unit distance between left and right sides	number	4	2.2.0
icon	the `Icon` type for an icon avatar, see `Icon` Component	VNode \| slot	-
loadError	handler when img load error, return false to prevent default fallback behavior	() => boolean	-
shape	the shape of avatar	`circle` \| `square`	`circle`
size	The size of the avatar	number \| `large` \| `small` \| `default` \| { xs: number, sm: number, ...}	`default`	2.2.0
src	the address of the image for an image avatar	string	-
srcset	a list of sources to use for different screen resolutions	string	-

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`	3.0
maxStyle	The style of excess avatar style	CSSProperties	-
size	The size of the avatar	number \| `large` \| `small` \| `default` \| { xs: number, sm: number, ...}	`default`