Icon API
The API documentation of the Icon React component. Learn more about the props and the CSS customization points.
import { Icon } from '@material-ui/core';
Props
Name | Type | Default | Description |
---|---|---|---|
children | node | The name of the icon font ligature. | |
classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
color | 'inherit' | 'primary' | 'secondary' | 'action' | 'error' | 'disabled' |
'inherit' | The color of the component. It supports those theme colors that make sense for this component. |
component | elementType | 'span' | The component used for the root node. Either a string to use a DOM element or a component. |
fontSize | 'inherit' | 'default' | 'small' | 'large' |
'default' | 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
- Style sheet name:
MuiIcon
. - Style sheet details:
Rule name | Global class | Description |
---|---|---|
root | MuiIcon-root | Styles applied to the root element. |
colorPrimary | MuiIcon-colorPrimary | Styles applied to the root element if color="primary" . |
colorSecondary | MuiIcon-colorSecondary | Styles applied to the root element if color="secondary" . |
colorAction | MuiIcon-colorAction | Styles applied to the root element if color="action" . |
colorError | MuiIcon-colorError | Styles applied to the root element if color="error" . |
colorDisabled | MuiIcon-colorDisabled | Styles applied to the root element if color="disabled" . |
fontSizeInherit | MuiIcon-fontSizeInherit | |
fontSizeSmall | MuiIcon-fontSizeSmall | Styles applied to the root element if fontSize="small" . |
fontSizeLarge | MuiIcon-fontSizeLarge | Styles applied to the root element if fontSize="large" . |
You can override the style of the component thanks to one of these customization points:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
overrides
property.
If that's not sufficient, you can check the implementation of the component for more detail.
Notes
The component is fully StrictMode compatible.