Avatar

Avatar

The API documentation of the Avatar React component.

Props

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. src and alt props will not be used and no img will be rendered by default.
This can be an element, or just a string.
classes object   Override or extend the styles applied to the component. See CSS API below for more details.
component union: string |
 func |
 object
'div' The component used for the root node. Either a string to use a DOM element or a component.
imgProps object   Attributes applied to the img element if the component is used to display an image.
sizes string   The sizes attribute for the img element.
src string   The src attribute for the img element.
srcSet string   The srcSet attribute for the img element.

Any other properties supplied will be spread to the root element (native element).

CSS API

You can override all the class names injected by Material-UI thanks to the classes property. This property accepts the following keys:

Name Description
root Styles applied to the root element.
colorDefault Styles applied to the root element if color="default".
img Styles applied to the img element if either src or srcSet is defined.

Have a look at overriding with classes section and the implementation of the component for more detail.

If using the overrides key of the theme as documented here, you need to use the following style sheet name: MuiAvatar.

Demos