Avatar API

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

Component demos

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

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.

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

color

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.

Default:'neutral'

component

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

Type:elementType

size

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.

Type:'lg' | 'md' | 'sm' | string

Default:'md'

slotProps

The props used for each slot inside.

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

Default:{}

slots

The components used for each slot inside.

See Slots API below for more details.

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

Default:{}

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

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

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

Type:'outlined' | 'plain' | 'soft' | 'solid' | string

Default:'soft'

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.

root

The component that renders the root.

Class name: .MuiAvatar-root

Default component: 'div'

img

The component that renders the img.

Class name: .MuiAvatar-img

Default component: 'img'

fallback

The component that renders the fallback.

Class name: .MuiAvatar-fallback

Default component: 'svg'

CSS classes

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

.MuiAvatar-colorContext

Class name applied to the root element when color inversion is triggered.

Rule name:colorContext

.MuiAvatar-colorDanger

Class name applied to the root element if color="danger".

Rule name:colorDanger

.MuiAvatar-colorNeutral

Class name applied to the root element if color="neutral".

Rule name:colorNeutral

.MuiAvatar-colorPrimary

Class name applied to the root element if color="primary".

Rule name:colorPrimary

.MuiAvatar-colorSuccess

Class name applied to the root element if color="success".

Rule name:colorSuccess

.MuiAvatar-colorWarning

Class name applied to the root element if color="warning".

Rule name:colorWarning

.MuiAvatar-sizeLg

Class name applied to the root element if size="lg".

Rule name:sizeLg

.MuiAvatar-sizeMd

Class name applied to the root element if size="md".

Rule name:sizeMd

.MuiAvatar-sizeSm

Class name applied to the root element if size="sm".

Rule name:sizeSm

.MuiAvatar-variantOutlined

Class name applied to the root element if variant="outlined".

Rule name:variantOutlined

.MuiAvatar-variantSoft

Class name applied to the root element if variant="soft".

Rule name:variantSoft

.MuiAvatar-variantSolid

Class name applied to the root element if variant="solid".

Rule name:variantSolid

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.