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:

Button

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.

Name	Type	Default	Description
children	node	-	The icon to display.
classes	object	-	Override or extend the styles applied to the component. See CSS classes 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.
disabled	bool	false	If `true`, the component is disabled.
disableFocusRipple	bool	false	If `true`, the keyboard focus ripple is disabled.
disableRipple	bool	false	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).
loading	bool	false	If `true`, the loading indicator is visible and the button is disabled.
loadingIndicator	node	<CircularProgress color="inherit" size={16} />	Element placed before the children if the button is in loading state. The node should contain an element with `role="progressbar"` with an accessible name. By default, it renders a `CircularProgress` that is labeled by the button itself.
size	'small' \| 'medium' \| 'large' \| string	'medium'	The size of the component. `small` is equivalent to the dense button styling.
sx	Array<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 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 classes

These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.

Class name	Rule name	Description
.Mui-disabled		State class applied to the root element if `disabled={true}`.
.MuiIconButton-colorError	colorError	Styles applied to the root element if `color="error"`.
.MuiIconButton-colorInfo	colorInfo	Styles applied to the root element if `color="info"`.
.MuiIconButton-colorInherit	colorInherit	Styles applied to the root element if `color="inherit"`.
.MuiIconButton-colorPrimary	colorPrimary	Styles applied to the root element if `color="primary"`.
.MuiIconButton-colorSecondary	colorSecondary	Styles applied to the root element if `color="secondary"`.
.MuiIconButton-colorSuccess	colorSuccess	Styles applied to the root element if `color="success"`.
.MuiIconButton-colorWarning	colorWarning	Styles applied to the root element if `color="warning"`.
.MuiIconButton-edgeEnd	edgeEnd	Styles applied to the root element if `edge="end"`.
.MuiIconButton-edgeStart	edgeStart	Styles applied to the root element if `edge="start"`.
.MuiIconButton-loading	loading	Styles applied to the root element if `loading={true}`.
.MuiIconButton-loadingIndicator	loadingIndicator	Styles applied to the loadingIndicator element.
.MuiIconButton-root	root	Styles applied to the root element.
.MuiIconButton-sizeLarge	sizeLarge	Styles applied to the root element if `size="large"`.
.MuiIconButton-sizeMedium	sizeMedium	Styles applied to the root element if `size="medium"`.
.MuiIconButton-sizeSmall	sizeSmall	Styles applied to the root element if `size="small"`.

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

With a global class name.
With a rule name as part of the component's styleOverrides property in a custom theme.

Source code

If you did not find the information in this page, consider having a look at the implementation of the component for more detail.