Skip to content
Edit this page

Avatar API

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

Demos

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

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
sx

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

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiAvatar-rootroot

Styles applied to the root element.

.MuiAvatar-colorDefaultcolorDefault

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

.MuiAvatar-circularcircular

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

.MuiAvatar-roundedrounded

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

.MuiAvatar-squaresquare

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

.MuiAvatar-imgimg

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

.MuiAvatar-fallbackfallback

Styles applied to the fallback icon

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