跳转到内容

Icon API

API documentation for the React Icon component. Learn about the available props, and the CSS API.

Import

import Icon from '@material-ui/core/Icon';
// or
import { Icon } from '@material-ui/core';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiIcon can be used when providing default props or style overrides in the theme.

Props

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 (e.g. material-icons-rounded, fas, etc).
childrennodeThe name of the icon font ligature.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
color'action'
| 'disabled'
| 'error'
| 'inherit'
| 'primary'
| 'secondary'
'inherit'The color of the component. It supports those theme colors that make sense for this component.
componentelementTypeThe component used for the root node. Either a string to use a HTML element or a component.
fontSize'inherit'
| 'large'
| 'medium'
| 'small'
'medium'The fontSize applied to the icon. Defaults to 24px, but can be configure to inherit font size.

The ref is forwarded to the root element.
Any other props supplied will be provided to the root element (native element).

CSS

Rule nameGlobal classDescription
root.MuiIcon-rootStyles applied to the root element.
colorPrimary.MuiIcon-colorPrimaryStyles applied to the root element if color="primary".
colorSecondary.MuiIcon-colorSecondaryStyles applied to the root element if color="secondary".
colorAction.MuiIcon-colorActionStyles applied to the root element if color="action".
colorError.MuiIcon-colorErrorStyles applied to the root element if color="error".
colorDisabled.MuiIcon-colorDisabledStyles applied to the root element if color="disabled".
fontSizeInherit.MuiIcon-fontSizeInheritStyles applied to the root element if fontSize="inherit".
fontSizeSmall.MuiIcon-fontSizeSmallStyles applied to the root element if fontSize="small".
fontSizeLarge.MuiIcon-fontSizeLargeStyles applied to the root element if fontSize="large".

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos