Skip to content

IconButton API

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

Import

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

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

Component name

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

Props

NameTypeDefaultDescription
childrennodeThe icon to display.
classesobjectOverride 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.
disabledboolfalseIf true, the component is disabled.
disableFocusRippleboolfalseIf true, the keyboard focus ripple is disabled.
disableRippleboolfalseIf true, the ripple effect is disabled.
⚠️ Without a ripple there is no styling for :focus-visible by default. Be sure to highlight the element by applying separate styles with the .Mui-focusedVisible class.
edge'end'
| 'start'
| false
falseIf 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'medium'
| 'small'
'medium'The size of the component. 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).

Inheritance

While not explicitly documented above, the props of the ButtonBase component are also available on IconButton. You can take advantage of this to target nested components.

CSS

Rule nameGlobal classDescription
root.MuiIconButton-rootStyles applied to the root element.
edgeStart.MuiIconButton-edgeStartStyles applied to the root element if edge="start".
edgeEnd.MuiIconButton-edgeEndStyles applied to the root element if edge="end".
colorInherit.MuiIconButton-colorInheritStyles applied to the root element if color="inherit".
colorPrimary.MuiIconButton-colorPrimaryStyles applied to the root element if color="primary".
colorSecondary.MuiIconButton-colorSecondaryStyles applied to the root element if color="secondary".
disabled.Mui-disabledPseudo-class applied to the root element if disabled={true}.
sizeSmall.MuiIconButton-sizeSmallStyles applied to the root element if size="small".
label.MuiIconButton-labelStyles applied to the children container element.

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