ant-design/components/avatar/index.en-US.md
xrkffgg 94edeaa02f
feat: add avatar gap api (#24357)
* feat: add avatar gap api

* docs: update explain

* fix: gap in span

* docs: update

* fix: test

* remove lastgap
2020-05-25 17:56:48 +08:00

21 lines
930 B
Markdown

---
category: Components
type: Data Display
title: Avatar
---
Avatars can be used to represent people or objects. It supports images, `Icon`s, or letters.
## API
| 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` | `default` | |
| 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 |