Skip to content

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/joy/IconButton';
// or
import { IconButton } from '@mui/joy';
Learn about the difference by reading this guide on minimizing bundle size.

Props

NameTypeDefaultDescription
actionfunc
| { current?: { focusVisible: func } }

A ref for imperative actions. It currently only supports focusVisible() action.

color'danger'
| 'neutral'
| 'primary'
| 'success'
| 'warning'
| string
'neutral'

The color of the component. It supports those theme colors that make sense for this component.

To learn how to add your own colors, check out Themed components—Extend colors.

componentelementType

The component used for the root node. Either a string to use a HTML element or a component.

disabledboolfalse

If true, the component is disabled.

focusVisibleClassNamestring

This prop can help identify which element has keyboard focus. The class name will be applied when the element gains the focus through keyboard interaction. It's a polyfill for the CSS :focus-visible selector. The rationale for using this feature is explained here. A polyfill can be used to apply a focus-visible class to other components if needed.

loadingboolfalse

If true, the loading indicator is shown and the icon button becomes disabled.

loadingIndicatornode<CircularProgress />

The node should contain an element with role="progressbar" with an accessible name. By default we render a CircularProgress that is labelled by the button itself.

size'sm'
| 'md'
| 'lg'
| string
'md'

The size of the component.

To learn how to add custom sizes to the component, check out Themed components—Extend sizes.

slotProps{ loadingIndicator?: func
| object, root?: func
| object }
{}

The props used for each slot inside.

slots{ loadingIndicator?: elementType, root?: elementType }{}

The components used for each slot inside.

See Slots API below for more details.

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.

variant'outlined'
| 'plain'
| 'soft'
| 'solid'
| string
'plain'

The global variant to use.

To learn how to add your own variants, check out Themed components—Extend variants.

The ref is forwarded to the root element.

Theme default props

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


Slots

To learn how to customize the slot, check out the Overriding component structure guide.

Slot nameClass nameDefault componentDescription
root.MuiIconButton-root'button'The component that renders the root.
loadingIndicator.MuiIconButton-loadingIndicator'span'The component that renders the loading indicator.

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 nameRule nameDescription
.Mui-disabledState class applied to the root element if disabled={true}.
.Mui-focusVisibleState class applied to the root element if the button is keyboard focused.
.MuiIconButton-colorContextcolorContextClass name applied to the root element when color inversion is triggered.
.MuiIconButton-colorDangercolorDangerClass name applied to the root element if color="danger".
.MuiIconButton-colorNeutralcolorNeutralClass name applied to the root element if color="neutral".
.MuiIconButton-colorPrimarycolorPrimaryClass name applied to the root element if color="primary".
.MuiIconButton-colorSuccesscolorSuccessClass name applied to the root element if color="success".
.MuiIconButton-colorWarningcolorWarningClass name applied to the root element if color="warning".
.MuiIconButton-loadingloadingClass name applied to the root element if loading={true}.
.MuiIconButton-sizeLgsizeLgClass name applied to the root element if size="lg".
.MuiIconButton-sizeMdsizeMdClass name applied to the root element if size="md".
.MuiIconButton-sizeSmsizeSmClass name applied to the root element if size="sm".
.MuiIconButton-variantOutlinedvariantOutlinedClass name applied to the root element if variant="outlined".
.MuiIconButton-variantPlainvariantPlainClass name applied to the root element if variant="plain".
.MuiIconButton-variantSoftvariantSoftClass name applied to the root element if variant="soft".
.MuiIconButton-variantSolidvariantSolidClass name applied to the root element if variant="solid".

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