mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-04 13:08:41 +08:00
9101f3666a
fix lint and test failures update avatar demo card title update ts type check for undefined
39 lines
1.7 KiB
Markdown
39 lines
1.7 KiB
Markdown
---
|
||
category: Components
|
||
subtitle: 头像
|
||
type: 数据展示
|
||
title: Avatar
|
||
cover: https://gw.alipayobjects.com/zos/antfincdn/aBcnbw68hP/Avatar.svg
|
||
---
|
||
|
||
用来代表用户或事物，支持图片、图标或字符展示。
|
||
|
||
## 设计师专属
|
||
|
||
安装 [Kitchen Sketch 插件 💎](https://kitchen.alipay.com)，一键填充高逼格头像和文本.
|
||
|
||
## API
|
||
|
||
### Avatar
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| --- | --- | --- | --- | --- |
|
||
| icon | 设置头像的自定义图标 | ReactNode | - | |
|
||
| shape | 指定头像的形状 | `circle` \| `square` | `circle` | |
|
||
| size | 设置头像的大小 | number \| `large` \| `small` \| `default` \| `{ xs: number, sm: number, ...}` | `default` | 4.7.0 |
|
||
| src | 图片类头像的资源地址 | string | - | |
|
||
| srcSet | 设置图片类头像响应式资源地址 | string | - | |
|
||
| alt | 图像无法显示时的替代文本 | string | - | |
|
||
| onError | 图片加载失败的事件，返回 false 会关闭组件默认的 fallback 行为 | () => boolean | - | |
|
||
| gap | 字符类型距离左右两侧边界单位像素 | number | 4 | 4.3.0 |
|
||
|
||
> Tip：你可以设置 `icon` 或 `children` 作为图片加载失败的默认 fallback 行为，优先级为 `icon` > `children`
|
||
|
||
### Avatar.Group (4.5.0+)
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| ------------------- | -------------------- | ----------------- | ------ | ---- |
|
||
| maxCount | 显示的最大头像个数 | number | - | |
|
||
| maxStyle | 多余头像样式 | CSSProperties | - | |
|
||
| maxPopoverPlacement | 多余头像气泡弹出位置 | `top` \| `bottom` | `top` | |
|