IconButton API
API reference docs for the React IconButton component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import IconButton from '@mui/material/IconButton';
// or
import { IconButton } from '@mui/material';
Refer to the Icons section of the documentation regarding the available icon options.
Props of the ButtonBase component are also available.
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
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'
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
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
The size of the component. small
is equivalent to the dense button styling.
Type:'small'
| 'medium'
| 'large'
| string
Default:'medium'
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
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.
These class names are useful for styling with CSS. They are applied to the component's slots when specific states are triggered.
Styles applied to the root element if color="inherit"
.
Rule name:colorInherit
Styles applied to the root element if color="primary"
.
Rule name:colorPrimary
Styles applied to the root element if color="secondary"
.
Rule name:colorSecondary
Styles applied to the root element if color="success"
.
Rule name:colorSuccess
Styles applied to the root element if color="warning"
.
Rule name:colorWarning
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.