Avatar API

The API documentation of the Avatar React component. Learn more about the props and the CSS customization points.

Import

import Avatar from '@material-ui/core/Avatar';
// or
import { Avatar } from '@material-ui/core';

You can learn more about the difference by reading this guide.

Component name

The MuiAvatar name can be used for providing default props or style overrides at the theme level.

Props

Name	Type	Default	Description
alt	string		Used in combination with src or srcSet to provide an alt attribute for the rendered img element.
children	node		Used to render icon or text elements inside the Avatar if src is not set. This can be an element, or just a string.
classes	object		Override or extend the styles applied to the component. See CSS API below for more details.
component	elementType	'div'	The component used for the root node. Either a string to use a HTML element or a component.
imgProps	object		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.
sizes	string		The sizes attribute for the img element.
src	string		The src attribute for the img element.
srcSet	string		The srcSet attribute for the img element. Use this attribute for responsive image display.
variant	'circle' | 'circular' | 'rounded' | 'square'	'circle'	The shape of the avatar.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (native element).

CSS

Rule name	Global class	Description
root	.MuiAvatar-root	Styles applied to the root element.
colorDefault	.MuiAvatar-colorDefault	Styles applied to the root element if not src or srcSet.
circle	.MuiAvatar-circle	Styles applied to the root element if variant="circle".
circular	.MuiAvatar-circular	Styles applied to the root element if variant="circular".
rounded	.MuiAvatar-rounded	Styles applied to the root element if variant="rounded".
square	.MuiAvatar-square	Styles applied to the root element if variant="square".
img	.MuiAvatar-img	Styles applied to the img element if either src or srcSet is defined.
fallback	.MuiAvatar-fallback	Styles applied to the fallback icon

You can override the style of the component thanks to one of these customization points:

• With a rule name of the classes object prop.
• With a global class name.
• With a theme and an overrides property.

If that's not sufficient, you can check the implementation of the component for more detail.

Demos

• Avatars