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';
Component name
The nameMuiIcon
can be used when providing default props or style overrides in the theme.Props
Name | Type | Default | Description |
---|---|---|---|
baseClassName | string | '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). |
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 | 'action' | 'disabled' | 'error' | 'inherit' | 'primary' | 'secondary' | 'inherit' | The color of the component. It supports those theme colors that make sense for this component. |
component | elementType | The component used for the root node. Either a string to use a HTML element or a component. | |
fontSize | 'default' | 'inherit' | 'large' | 'small' | '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
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 | Styles applied to the root element if fontSize="inherit" . |
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 using one of these customization options:
- With a rule name of the
classes
object prop. - With a global class name.
- With a theme and an
styleOverrides
property.