Skip to content
IconButton

IconButton API

The API documentation of the IconButton React component. Learn more about the properties and the CSS customization points.

import IconButton from '@material-ui/core/IconButton';

Refer to the Icons section of the documentation regarding the available icon options.

Props

Name Type Default Description
children node The icon element.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
color enum: 'default' |
 'inherit' |
 'primary' |
 'secondary'
'default' The color of the component. It supports those theme colors that make sense for this component.
disabled bool false If true, the button will be disabled.
disableFocusRipple bool false If true, the keyboard focus ripple will be disabled. disableRipple must also be true.
disableRipple bool If true, the ripple effect will be disabled.
edge enum: 'start' |
 'end' |
 false
false If given, uses a negative margin to counteract the padding on one side (this is often helpful for aligning the left or right side of the icon with content above or below, without ruining the border size and shape).
size enum: 'small' |
 'medium'
'medium' The size of the button. small is equivalent to the dense button styling.

The ref is forwarded to the root element.

Any other properties supplied will be provided to the root element (ButtonBase).

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.
edgeStart Styles applied to the root element if edge="start".
edgeEnd Styles applied to the root element if edge="end".
colorInherit Styles applied to the root element if color="inherit".
colorPrimary Styles applied to the root element if color="primary".
colorSecondary Styles applied to the root element if color="secondary".
disabled Pseudo-class applied to the root element if disabled={true}.
sizeSmall Styles applied to the root element if size="small".
label Styles applied to the children container element.

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: MuiIconButton.

Inheritance

The properties of the ButtonBase component are also available. You can take advantage of this behavior to target nested components.

Notes

The component can cause issues in StrictMode.

Demos