Skip to content
Edit this page

IconButton API

API reference docs for the React IconButton component. Learn about the props, CSS, and other APIs of this exported module.

Demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import IconButton from '@mui/material/IconButton';
// or
import { IconButton } from '@mui/material';
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

Props of the ButtonBase component are also available.

NameTypeDefaultDescription
childrennode
The icon to display.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
color'inherit'
| 'default'
| 'primary'
| 'secondary'
| 'error'
| 'info'
| 'success'
| 'warning'
| string		'default'
The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.
disabledboolfalse
If true, the component is disabled.
disableFocusRippleboolfalse
If true, the keyboard focus ripple is disabled.
disableRippleboolfalse
If 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-focusVisible class.
edge'end'
| 'start'
| 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'
| 'large'
| string		'medium'
The size of the component. small is equivalent to the dense button styling.
sxArray<func
| object
| bool>
| func
| object
The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.

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".
colorError.MuiIconButton-colorErrorStyles applied to the root element if color="error".
colorInfo.MuiIconButton-colorInfoStyles applied to the root element if color="info".
colorSuccess.MuiIconButton-colorSuccessStyles applied to the root element if color="success".
colorWarning.MuiIconButton-colorWarningStyles applied to the root element if color="warning".
disabled.Mui-disabledState class applied to the root element if disabled={true}.
sizeSmall.MuiIconButton-sizeSmallStyles applied to the root element if size="small".
sizeMedium.MuiIconButton-sizeMediumStyles applied to the root element if size="medium".
sizeLarge.MuiIconButton-sizeLargeStyles applied to the root element if size="large".

You can override the style of the component using one of these customization options: