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';
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.

Props

Props of the ButtonBase component are also available.

children

The icon to display.

Type:

node
classes

Override or extend the styles applied to the component.

See CSS API below for more details.

Type:

object
color

The color of the component. It supports both default and custom theme colors, which can be added as shown in the palette customization guide.

Type:

'inherit' | 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string

Default:

'default'
disabled

If true, the component is disabled.

Type:

bool

Default:

false
disableFocusRipple

If true, the keyboard focus ripple is disabled.

Type:

bool

Default:

false
disableRipple

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.

Type:

bool

Default:

false
edge

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).

Type:

'end' | 'start' | false

Default:

false
size

The size of the component. small is equivalent to the dense button styling.

Type:

'small' | 'medium' | 'large' | string

Default:

'medium'
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
The ref is forwarded to the root element.

Inheritance

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

Theme default props

You can use MuiIconButton to change the default props of this component with the theme.

CSS

The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.


.MuiIconButton-rootroot

Styles applied to the root element.

.MuiIconButton-edgeStartedgeStart

Styles applied to the root element if edge="start".

.MuiIconButton-edgeEndedgeEnd

Styles applied to the root element if edge="end".

.MuiIconButton-colorInheritcolorInherit

Styles applied to the root element if color="inherit".

.MuiIconButton-colorPrimarycolorPrimary

Styles applied to the root element if color="primary".

.MuiIconButton-colorSecondarycolorSecondary

Styles applied to the root element if color="secondary".

.MuiIconButton-colorErrorcolorError

Styles applied to the root element if color="error".

.MuiIconButton-colorInfocolorInfo

Styles applied to the root element if color="info".

.MuiIconButton-colorSuccesscolorSuccess

Styles applied to the root element if color="success".

.MuiIconButton-colorWarningcolorWarning

Styles applied to the root element if color="warning".

.Mui-disableddisabledSTATE

State class applied to the root element if disabled={true}.

.MuiIconButton-sizeSmallsizeSmall

Styles applied to the root element if size="small".

.MuiIconButton-sizeMediumsizeMedium

Styles applied to the root element if size="medium".

.MuiIconButton-sizeLargesizeLarge

Styles applied to the root element if size="large".

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