Avatar API

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

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

Avatar

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.

alt

Used in combination with src or srcSet to provide an alt attribute for the rendered img element.

Type:string

children

Used to render icon or text elements inside the Avatar if src is not set. This can be an element, or just a string.

Type:node

classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:object

component

The component used for the root node. Either a string to use a HTML element or a component.

Type:elementType

imgProps

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.

Type:object

sizes

The sizes attribute for the img element.

Type:string

src

The src attribute for the img element.

Type:string

srcSet

The srcSet attribute for the img element. Use this attribute for responsive image display.

Type:string

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:Array<func | object | bool> | func | object

variant

The shape of the avatar.

Type:'circular' | 'rounded' | 'square' | string

Default:'circular'

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.

CSS classes

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

.MuiAvatar-circular

Styles applied to the root element if variant="circular".

Rule name:circular

.MuiAvatar-colorDefault

Styles applied to the root element if not src or srcSet.

Rule name:colorDefault

.MuiAvatar-fallback

Styles applied to the fallback icon

Rule name:fallback

.MuiAvatar-img

Styles applied to the img element if either src or srcSet is defined.

Rule name:img

.MuiAvatar-root

Styles applied to the root element.

Rule name:root

.MuiAvatar-rounded

Styles applied to the root element if variant="rounded".

Rule name:rounded

.MuiAvatar-square

Styles applied to the root element if variant="square".

Rule name:square

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.