Skip to content
Edit this page

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

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.

Type:

'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string

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'.

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.

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
sx

The system prop that allows defining system overrides as well as additional CSS styles.

Type:

Array<func | object | bool> | func | object
variant

The global variant to use.

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'div'Required

Global class: .MuiAvatar-root

Description: The component that renders the root.

img'img'Required

Global class: .MuiAvatar-img

Description: The component that renders the img.

fallback'svg'Required

Global class: .MuiAvatar-fallback

Description: The component that renders the fallback.

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

CSS classes

These class names are useful for styling with CSS. They are applied to the root slot when specific states are triggered.

.MuiAvatar-colorContext

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

.MuiAvatar-colorDanger

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

.MuiAvatar-colorNeutral

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

.MuiAvatar-colorPrimary

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

.MuiAvatar-colorSuccess

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

.MuiAvatar-colorWarning

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

.MuiAvatar-sizeLg

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

.MuiAvatar-sizeMd

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

.MuiAvatar-sizeSm

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

.MuiAvatar-variantOutlined

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

.MuiAvatar-variantSoft

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

.MuiAvatar-variantSolid

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