Skip to content
Edit this page

IconButton API

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

Import

import IconButton from '@material-ui/core/IconButton';
// or
import { IconButton } from '@material-ui/core';

You can learn more about the difference by reading this guide.

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

Component name

The MuiIconButton name can be used for providing default props or style overrides at the theme level.

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 '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 '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 '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 props supplied will be provided to the root element (ButtonBase).

CSS

Rule name Global class Description
root .MuiIconButton-root Styles applied to the root element.
edgeStart .MuiIconButton-edgeStart Styles applied to the root element if edge="start".
edgeEnd .MuiIconButton-edgeEnd Styles applied to the root element if edge="end".
colorInherit .MuiIconButton-colorInherit Styles applied to the root element if color="inherit".
colorPrimary .MuiIconButton-colorPrimary Styles applied to the root element if color="primary".
colorSecondary .MuiIconButton-colorSecondary Styles applied to the root element if color="secondary".
disabled .Mui-disabled Pseudo-class applied to the root element if disabled={true}.
sizeSmall .MuiIconButton-sizeSmall Styles applied to the root element if size="small".
label .MuiIconButton-label Styles applied to the children container element.

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Inheritance

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

Demos