Skip to content
Edit this page

Avatar API

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

Import

import Avatar from '@material-ui/core/Avatar';
// or
import { Avatar } from '@material-ui/core';
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

NameTypeDefaultDescription
altstringUsed in combination with src or srcSet to provide an alt attribute for the rendered img element.
childrennodeUsed to render icon or text elements inside the Avatar if src is not set. This can be an element, or just a string.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
imgPropsobjectAttributes 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.
sizesstringThe sizes attribute for the img element.
srcstringThe src attribute for the img element.
srcSetstringThe srcSet attribute for the img element. Use this attribute for responsive image display.
variant'circular'
| 'rounded'
| 'square'
| string		'circular'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 nameGlobal classDescription
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: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos