跳到内容跳到内容
🚀 影响 Joy UI 2025 年的路线图！参与最新的开发者调查

AvatarAPI

React Avatar 组件的 API 参考文档。了解此导出的模块的 props、CSS 和其他 API。

演示

Import

import Avatar from '@mui/joy/Avatar';
// or
import { Avatar } from '@mui/joy';

阅读关于最小化 bundle size 的指南，了解它们之间的区别。

Props

原生组件的 Props 也可用。

名称类型默认值描述
altstring-

与 src 或 srcSet 结合使用，为渲染的 img 元素提供 alt 属性。

childrennode-

如果未设置 src，则用于在 Avatar 内部渲染图标或文本元素。这可以是元素，也可以只是字符串。

color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string		'neutral'

组件的颜色。它支持对该组件有意义的那些主题颜色。

要了解如何添加您自己的颜色，请查看主题组件—扩展颜色。

componentelementType-

用于根节点的组件。可以是用于 HTML 元素的字符串或组件。

size'lg'
| 'md'
| 'sm'
| string		'md'

组件的大小。它接受 'sm' 和 'lg' 之间的主题值。

要了解如何向组件添加自定义尺寸，请查看主题组件—扩展尺寸。

slotProps{ fallback?: func
| object, img?: func
| object, root?: func
| object }		{}

用于内部每个 slot 的 props。

slots{ fallback?: elementType, img?: elementType, root?: elementType }{}

用于内部每个 slot 的组件。

有关更多详细信息，请参见下方的Slots API。

srcstring-

img 元素的 src 属性。

srcSetstring-

img 元素的 srcSet 属性。使用此属性进行响应式图像显示。

sxArray<func
| object
| bool>
| func
| object		-

允许定义系统 overrides 以及其他 CSS 样式的系统 prop。

有关更多详细信息，请参见`sx` 页面。

variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string		'soft'

要使用的全局 variant。

要了解如何添加您自己的 variants，请查看主题组件—扩展 variants。

ref 被转发到根元素。

主题默认 props

您可以使用 JoyAvatar 通过主题更改此组件的默认 props。

Slots

要了解如何自定义 slot，请查看覆盖组件结构指南。

Slot 名称类名默认组件描述
root.MuiAvatar-root'div'渲染 root 的组件。
img.MuiAvatar-img'img'渲染 img 的组件。
fallback.MuiAvatar-fallback'svg'渲染 fallback 的组件。

CSS 类

这些类名对于使用 CSS 进行样式设置很有用。当触发特定状态时，它们会应用于组件的 slots。

类名规则名称描述
.MuiAvatar-colorContextcolorContext当颜色反转被触发时，应用于根元素的类名。
.MuiAvatar-colorDangercolorDanger如果 color="danger"，则应用于根元素的类名。
.MuiAvatar-colorNeutralcolorNeutral如果 color="neutral"，则应用于根元素的类名。
.MuiAvatar-colorPrimarycolorPrimary如果 color="primary"，则应用于根元素的类名。
.MuiAvatar-colorSuccesscolorSuccess如果 color="success"，则应用于根元素的类名。
.MuiAvatar-colorWarningcolorWarning如果 color="warning"，则应用于根元素的类名。
.MuiAvatar-sizeLgsizeLg如果 size="lg"，则应用于根元素的类名。
.MuiAvatar-sizeMdsizeMd如果 size="md"，则应用于根元素的类名。
.MuiAvatar-sizeSmsizeSm如果 size="sm"，则应用于根元素的类名。
.MuiAvatar-variantOutlinedvariantOutlined如果 variant="outlined"，则应用于根元素的类名。
.MuiAvatar-variantSoftvariantSoft如果 variant="soft"，则应用于根元素的类名。
.MuiAvatar-variantSolidvariantSolid如果 variant="solid"，则应用于根元素的类名。

您可以使用以下自定义选项之一来覆盖组件的样式

源代码

如果您在此页面中没有找到所需信息，请考虑查看组件的实现以获取更多详细信息。