Avatar API
The API documentation of the Avatar React component. Learn more about the properties and the CSS customization points.
import Avatar from '@material-ui/core/Avatar';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 | elementType | '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. |
The ref is forwarded to the root element.
Any other properties supplied will be provided to the root element (native element).
CSS
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 there are children and not src or srcSet. |
| img | Styles applied to the img element if either src or srcSet is defined. |
Have a look at the overriding styles with classes section and the implementation of the component for more detail.
If using the overrides key of the theme,
you need to use the following style sheet name: MuiAvatar.
Notes
The component is fully StrictMode compatible.