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 Avatar from '@mui/joy/Avatar';
// or
import { Avatar } from '@mui/joy';

The name JoyAvatar can be used when providing default props or style overrides in the theme.

Props of the native component are also available.

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.
color	'danger' \| 'info' \| 'neutral' \| 'primary' \| 'success' \| 'warning' \| string	'neutral'	The color of the component. It supports those theme colors that make sense for this component.
size	'lg' \| 'md' \| 'sm' \| string	'md'	The size of the component. It accepts theme values between 'sm' and 'lg'.
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.
sx	Array<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	'outlined' \| 'plain' \| 'soft' \| 'solid' \| string	'soft'	The variant to use.

The ref is forwarded to the root element.