[go: up one dir, main page]

Skip to content

Icon API

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

DemosImport
import Icon from '@mui/material/Icon';
// or
import { Icon } from '@mui/material';

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

Props

Props of the native component are also available.

NameTypeDefaultDescription
baseClassNamestring'material-icons'

The base class applied to the icon. Defaults to 'material-icons', but can be changed to any other base class that suits the icon font you're using (for example material-icons-rounded, fas, etc).

childrennode-

The name of the icon font ligature.

classesobject-

Override or extend the styles applied to the component.

See CSS classes API below for more details.

color'inherit'
| 'action'
| 'disabled'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string
'inherit'

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

componentelementType-

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

fontSize'inherit'
| 'large'
| 'medium'
| 'small'
| string
'medium'

The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.

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.

The ref is forwarded to the root element.
Theme default props

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

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
.MuiIcon-colorActioncolorActionStyles applied to the root element if color="action".
.MuiIcon-colorDisabledcolorDisabledStyles applied to the root element if color="disabled".
.MuiIcon-colorErrorcolorErrorStyles applied to the root element if color="error".
.MuiIcon-colorPrimarycolorPrimaryStyles applied to the root element if color="primary".
.MuiIcon-colorSecondarycolorSecondaryStyles applied to the root element if color="secondary".
.MuiIcon-fontSizeInheritfontSizeInheritStyles applied to the root element if fontSize="inherit".
.MuiIcon-fontSizeLargefontSizeLargeStyles applied to the root element if fontSize="large".
.MuiIcon-fontSizeSmallfontSizeSmallStyles applied to the root element if fontSize="small".
.MuiIcon-rootrootStyles applied to the root element.

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

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.