Skip to content

Avatar API

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

Demos

Import

import Avatar from '@mui/joy/Avatar';
// or
import { Avatar } from '@mui/joy';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Props of the native component are also available.

NameTypeDefaultDescription
altstring-

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

childrennode-

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'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
'neutral'

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

componentelementType-

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

size'lg'
| 'md'
| 'sm'
| string
'md'

The size of the component. It accepts theme values between 'sm' and 'lg'.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

slotProps{ fallback?: func
| object, img?: func
| object, root?: func
| object }
{}

The props used for each slot inside.

slots{ fallback?: elementType, img?: elementType, root?: elementType }{}

The components used for each slot inside.

See Slots API below for more details.

srcstring-

The src attribute for the img element.

srcSetstring-

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

sxArray<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 global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

You can use JoyAvatar to change the default props of this component with the theme.

Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot nameClass nameDefault componentDescription
root.MuiAvatar-root'div'The component that renders the root.
img.MuiAvatar-img'img'The component that renders the img.
fallback.MuiAvatar-fallback'svg'The component that renders the fallback.

CSS classes

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

Class nameRule nameDescription
.MuiAvatar-colorContextcolorContextClass name applied to the root element when color inversion is triggered.
.MuiAvatar-colorDangercolorDangerClass name applied to the root element if color="danger".
.MuiAvatar-colorNeutralcolorNeutralClass name applied to the root element if color="neutral".
.MuiAvatar-colorPrimarycolorPrimaryClass name applied to the root element if color="primary".
.MuiAvatar-colorSuccesscolorSuccessClass name applied to the root element if color="success".
.MuiAvatar-colorWarningcolorWarningClass name applied to the root element if color="warning".
.MuiAvatar-sizeLgsizeLgClass name applied to the root element if size="lg".
.MuiAvatar-sizeMdsizeMdClass name applied to the root element if size="md".
.MuiAvatar-sizeSmsizeSmClass name applied to the root element if size="sm".
.MuiAvatar-variantOutlinedvariantOutlinedClass name applied to the root element if variant="outlined".
.MuiAvatar-variantSoftvariantSoftClass name applied to the root element if variant="soft".
.MuiAvatar-variantSolidvariantSolidClass name applied to the root element if variant="solid".

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