IconButton API
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';
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 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). |
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 on IconButton. You can take advantage of this to target nested components.Theme default props
You can useMuiIconButton
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.
Rule name | Global class | Description |
---|---|---|
root | .MuiIconButton-root | Styles applied to the root element. |
edgeStart | .MuiIconButton-edgeStart | Styles applied to the root element if edge="start" . |
edgeEnd | .MuiIconButton-edgeEnd | Styles applied to the root element if edge="end" . |
colorInherit | .MuiIconButton-colorInherit | Styles applied to the root element if color="inherit" . |
colorPrimary | .MuiIconButton-colorPrimary | Styles applied to the root element if color="primary" . |
colorSecondary | .MuiIconButton-colorSecondary | Styles applied to the root element if color="secondary" . |
colorError | .MuiIconButton-colorError | Styles applied to the root element if color="error" . |
colorInfo | .MuiIconButton-colorInfo | Styles applied to the root element if color="info" . |
colorSuccess | .MuiIconButton-colorSuccess | Styles applied to the root element if color="success" . |
colorWarning | .MuiIconButton-colorWarning | Styles applied to the root element if color="warning" . |
disabled STATE | .Mui-disabled | State class applied to the root element if disabled={true} . |
sizeSmall | .MuiIconButton-sizeSmall | Styles applied to the root element if size="small" . |
sizeMedium | .MuiIconButton-sizeMedium | Styles applied to the root element if size="medium" . |
sizeLarge | .MuiIconButton-sizeLarge | Styles applied to the root element if size="large" . |
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.