mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-13 23:59:12 +08:00
c93bd326f4
* docs(update): removed 3.x version description in 4.0-prepare ref #19815 * docs(update): update docs remove carousel/index.zh-CN.md empty version column * docs(update): update docs remove carousel/index.en-US.md empty version column
20 lines
846 B
Markdown
20 lines
846 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 \| string: `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 | - | |
|