跳转到内容

Avatar API

API documentation for the React Avatar component. Learn about the available props, and the CSS API.

Import

import Avatar from '@mui/material/Avatar';
// 或
import { Avatar } from '@mui/material';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiAvatar can be used when providing default props or style overrides in the theme.

属性

Props of the 原生(Native) component are also available.

名称类型默认值描述
altstring
Used in combination with src or srcSet to provide an alt attribute for the rendered img element.
childrennode
Used to render icon or text elements inside the Avatar if src is not set. This can be an element, or just a string.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
componentelementType
The component used for the root node. Either a string to use a HTML element or a component.
imgPropsobject
Attributes applied to the img element if the component is used to display an image. It can be used to listen for the loading error event.
sizesstring
The sizes attribute for the img element.
srcstring
The src attribute for the img element.
srcSetstring
The srcSet attribute for the img element. Use this attribute for responsive image display.
sxArray<func
| object>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.
variant'circular'
| 'rounded'
| 'square'
| string
'circular'
The shape of the avatar.

ref 则会被传递到根元素中。

CSS

Rule nameGlobal class描述
root.MuiAvatar-rootStyles applied to the root element.
colorDefault.MuiAvatar-colorDefaultStyles applied to the root element if not src or srcSet.
circular.MuiAvatar-circularStyles applied to the root element if variant="circular".
rounded.MuiAvatar-roundedStyles applied to the root element if variant="rounded".
square.MuiAvatar-squareStyles applied to the root element if variant="square".
img.MuiAvatar-imgStyles applied to the img element if either src or srcSet is defined.
fallback.MuiAvatar-fallbackStyles applied to the fallback icon

You can override the style of the component using one of these customization options:

Demos