mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-02 15:59:38 +08:00
e7edfa42d7
* docs: update overview img * chore: code clean * chore: code clean * chore: update * chore: code clean
59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
---
|
||
category: Components
|
||
subtitle: 头像
|
||
title: Avatar
|
||
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*JJBSS5lBG4IAAAAAAAAAAAAADrJ8AQ/original
|
||
demo:
|
||
cols: 2
|
||
group:
|
||
title: 数据展示
|
||
order: 5
|
||
---
|
||
|
||
用来代表用户或事物，支持图片、图标或字符展示。
|
||
|
||
## 设计师专属
|
||
|
||
安装 [Kitchen Sketch 插件 💎](https://kitchen.alipay.com)，一键填充高逼格头像和文本。
|
||
|
||
## 代码演示
|
||
|
||
<!-- prettier-ignore -->
|
||
<code src="./demo/basic.tsx">基本</code>
|
||
<code src="./demo/type.tsx">类型</code>
|
||
<code src="./demo/dynamic.tsx">自动调整字符大小</code>
|
||
<code src="./demo/badge.tsx">带徽标的头像</code>
|
||
<code src="./demo/group.tsx">Avatar.Group</code>
|
||
<code src="./demo/toggle-debug.tsx" debug>隐藏情况下计算字符对齐</code>
|
||
<code src="./demo/responsive.tsx">响应式尺寸</code>
|
||
<code src="./demo/fallback.tsx" debug>图片不存在时</code>
|
||
|
||
## API
|
||
|
||
### Avatar
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| --- | --- | --- | --- | --- |
|
||
| alt | 图像无法显示时的替代文本 | string | - | |
|
||
| gap | 字符类型距离左右两侧边界单位像素 | number | 4 | 4.3.0 |
|
||
| icon | 设置头像的自定义图标 | ReactNode | - | |
|
||
| shape | 指定头像的形状 | `circle` \| `square` | `circle` | |
|
||
| size | 设置头像的大小 | number \| `large` \| `small` \| `default` \| { xs: number, sm: number, ...} | `default` | 4.7.0 |
|
||
| src | 图片类头像的资源地址或者图片元素 | string \| ReactNode | - | ReactNode: 4.8.0 |
|
||
| srcSet | 设置图片类头像响应式资源地址 | string | - | |
|
||
| draggable | 图片是否允许拖动 | boolean \| `'true'` \| `'false'` | - | |
|
||
| crossOrigin | CORS 属性设置 | `'anonymous'` \| `'use-credentials'` \| `''` | - | 4.17.0 |
|
||
| onError | 图片加载失败的事件，返回 false 会关闭组件默认的 fallback 行为 | () => boolean | - | |
|
||
|
||
> Tip：你可以设置 `icon` 或 `children` 作为图片加载失败的默认 fallback 行为，优先级为 `icon` > `children`
|
||
|
||
### Avatar.Group (4.5.0+)
|
||
|
||
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|
||
| --- | --- | --- | --- | --- |
|
||
| maxCount | 显示的最大头像个数 | number | - | |
|
||
| maxPopoverPlacement | 多余头像气泡弹出位置 | `top` \| `bottom` | `top` | |
|
||
| maxPopoverTrigger | 设置多余头像 Popover 的触发方式 | `hover` \| `focus` \| `click` | `hover` | 4.17.0 |
|
||
| maxStyle | 多余头像样式 | CSSProperties | - | |
|
||
| size | 设置头像的大小 | number \| `large` \| `small` \| `default` \| { xs: number, sm: number, ...} | `default` | 4.8.0 |
|