Skip to content

Avatar API

API reference docs for the React Avatar component. Learn about the props, CSS, and other APIs of this exported module.

Demos

Import

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

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
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 classes 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.

slotProps{ img?: func
| object }
{}

The props used for each slot inside.

slots{ img?: elementType }{}

The components used for each slot inside.

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
| bool>
| 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.

The ref is forwarded to the root element.

Theme default props

You can use MuiAvatar to change the default props of this component with the theme.

Slots

Slot nameClass nameDefault componentDescription
img.MuiAvatar-imgCollapseThe component that renders the transition. Follow this guide to learn more about the requirements for this component.

CSS classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class nameRule nameDescription
.MuiAvatar-circularcircularStyles applied to the root element if variant="circular".
.MuiAvatar-colorDefaultcolorDefaultStyles applied to the root element if not src or srcSet.
.MuiAvatar-fallbackfallbackStyles applied to the fallback icon
.MuiAvatar-rootrootStyles applied to the root element.
.MuiAvatar-roundedroundedStyles applied to the root element if variant="rounded".
.MuiAvatar-squaresquareStyles applied to the root element if variant="square".

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.