128 lines
4.7 KiB
Markdown
128 lines
4.7 KiB
Markdown
---
|
||
title: Avatar 头像
|
||
description: 用于展示用户头像信息，除了纯展示也可点击进入个人详情等操作。
|
||
spline: data
|
||
isComponent: true
|
||
---
|
||
|
||
<span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20lines-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20functions-100%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20statements-99%25-blue" /></span><span class="coverages-badge" style="margin-right: 10px"><img src="https://img.shields.io/badge/coverages%3A%20branches-85%25-blue" /></span>
|
||
## 引入
|
||
|
||
全局引入，在 miniprogram 根目录下的`app.json`中配置，局部引入，在需要引入的页面或组件的`index.json`中配置。
|
||
|
||
```json
|
||
"usingComponents": {
|
||
"t-avatar": "tdesign-miniprogram/avatar/avatar",
|
||
"t-avatar-group": "tdesign-miniprogram/avatar-group/avatar-group"
|
||
}
|
||
```
|
||
|
||
## 代码演示
|
||
|
||
### 头像类型
|
||
|
||
图片头像
|
||
|
||
{{ image-avatar }}
|
||
|
||
字符头像
|
||
|
||
{{ character-avatar }}
|
||
|
||
图标头像
|
||
|
||
{{ icon-avatar }}
|
||
|
||
徽标头像
|
||
|
||
{{ badge-avatar }}
|
||
|
||
|
||
### 组合头像
|
||
|
||
纯展示
|
||
|
||
{{ exhibition }}
|
||
|
||
带操作
|
||
|
||
{{ action }}
|
||
|
||
### 头像尺寸
|
||
|
||
头像 large/medium/small 尺寸
|
||
|
||
{{ size }}
|
||
|
||
## API
|
||
### Avatar Props
|
||
|
||
名称 | 类型 | 默认值 | 说明 | 必传
|
||
-- | -- | -- | -- | --
|
||
alt | String | - | 头像替换文本，仅当图片加载失败时有效 | N
|
||
badge-props | Object | - | 头像右上角提示信息，继承 Badge 组件的全部特性。如：小红点，或者数字。TS 类型：`BadgeProps`，[Badge API Documents](./badge?tab=api)。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/avatar/type.ts) | N
|
||
bordered | Boolean | false | 已废弃。是否显示外边框 | N
|
||
hide-on-load-failed | Boolean | false | 加载失败时隐藏图片 | N
|
||
icon | String / Object | - | 图标。值为字符串表示图标名称，值为 `Object` 类型，表示透传至 `icon`。 | N
|
||
image | String | - | 图片地址 | N
|
||
image-props | Object | - | 透传至 Image 组件 | N
|
||
shape | String | circle | 形状。可选项：circle/round。TS 类型：`ShapeEnum ` `type ShapeEnum = 'circle' \| 'round'`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/avatar/type.ts) | N
|
||
size | String | medium | 尺寸，示例值：small/medium/large/24px/38px 等 | N
|
||
|
||
### Avatar Events
|
||
|
||
名称 | 参数 | 描述
|
||
-- | -- | --
|
||
error | \- | 图片加载失败时触发
|
||
|
||
### Avatar 外部样式类
|
||
类名 | 说明
|
||
-- | --
|
||
t-class | 根节点样式类
|
||
t-class-image | 图片样式类
|
||
t-class-icon | 图标样式类
|
||
t-class-alt | 替代文本样式类
|
||
t-class-content | 内容样式类
|
||
|
||
### AvatarGroup Props
|
||
|
||
名称 | 类型 | 默认值 | 说明 | 必传
|
||
-- | -- | -- | -- | --
|
||
cascading | String | 'left-up' | 图片之间的层叠关系，可选值：左侧图片在上和右侧图片在上。可选项：left-up/right-up。TS 类型：`CascadingValue` `type CascadingValue = 'left-up' \| 'right-up'`。[详细类型定义](https://github.com/Tencent/tdesign-miniprogram/tree/develop/src/avatar-group/type.ts) | N
|
||
collapse-avatar | String / Slot | - | 头像数量超出时，会出现一个头像折叠元素。该元素内容可自定义。默认为 `+N`。示例：`+5`，`...`, `更多` | N
|
||
max | Number | - | 能够同时显示的最多头像数量 | N
|
||
size | String | medium | 尺寸，示例值：small/medium/large/24px/38px 等。优先级低于 Avatar.size | N
|
||
|
||
### AvatarGroup 外部样式类
|
||
类名 | 说明
|
||
-- | --
|
||
t-class | 根节点样式类
|
||
t-class-image | 图片样式类
|
||
t-class-content | 内容样式类
|
||
|
||
### CSS 变量
|
||
组件提供了下列 CSS 变量，可用于自定义样式。
|
||
名称 | 默认值 | 描述
|
||
-- | -- | --
|
||
--td-avatar-group-margin-left-large | -8px | -
|
||
--td-avatar-group-margin-left-medium | -6px | -
|
||
--td-avatar-group-margin-left-small | -4px | -
|
||
--td-avatar-bg-color | @brand-color-light-active | -
|
||
--td-avatar-border-color | #fff | -
|
||
--td-avatar-border-width-large | 8rpx | -
|
||
--td-avatar-border-width-medium | 6rpx | -
|
||
--td-avatar-border-width-small | 4rpx | -
|
||
--td-avatar-circle-border-radius | @radius-circle | -
|
||
--td-avatar-content-color | @brand-color | -
|
||
--td-avatar-icon-large-font-size | 64rpx | -
|
||
--td-avatar-icon-medium-font-size | 48rpx | -
|
||
--td-avatar-icon-small-font-size | 40rpx | -
|
||
--td-avatar-large-width | 128rpx | -
|
||
--td-avatar-margin-left | 0 | -
|
||
--td-avatar-medium-width | 96rpx | -
|
||
--td-avatar-round-border-radius | @radius-default | -
|
||
--td-avatar-small-width | 80rpx | -
|
||
--td-avatar-text-large-font-size | 16px | -
|
||
--td-avatar-text-medium-font-size | @font-size-base | -
|
||
--td-avatar-text-small-font-size | @font-size-s | -
|