Skip to content
Edit this page

LoadingButton API

API reference docs for the React LoadingButton 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 LoadingButton from '@mui/lab/LoadingButton';
// or
import { LoadingButton } from '@mui/lab';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiLoadingButton can be used when providing default props or style overrides in the theme.

Props

Props of the Button component are also available.

NameTypeDefaultDescription
childrennode
The content of the component.
classesobject
Override or extend the styles applied to the component. See CSS API below for more details.
disabledboolfalse
If true, the component is disabled.
loadingboolfalse
If true, the loading indicator is shown.
loadingIndicatornode<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 we render a CircularProgress that is labelled by the button itself.
loadingPosition'start'
| 'end'
| 'center'		'center'
The loading indicator can be positioned on the start, end, or the center of the button.
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'contained'
| 'outlined'
| 'text'
| string		'text'
The variant to use.

The ref is forwarded to the root element.

Inheritance

While not explicitly documented above, the props of the Button component are also available on LoadingButton. You can take advantage of this to target nested components.

CSS

Rule nameGlobal classDescription
root.MuiLoadingButton-rootStyles applied to the root element.
text.MuiLoadingButton-textStyles applied to the root element if variant="text".
textInherit.MuiLoadingButton-textInheritStyles applied to the root element if variant="text" and color="inherit".
textPrimary.MuiLoadingButton-textPrimaryStyles applied to the root element if variant="text" and color="primary".
textSecondary.MuiLoadingButton-textSecondaryStyles applied to the root element if variant="text" and color="secondary".
textSuccess.MuiLoadingButton-textSuccessStyles applied to the root element if variant="text" and color="success".
textError.MuiLoadingButton-textErrorStyles applied to the root element if variant="text" and color="error".
textInfo.MuiLoadingButton-textInfoStyles applied to the root element if variant="text" and color="info".
textWarning.MuiLoadingButton-textWarningStyles applied to the root element if variant="text" and color="warning".
outlined.MuiLoadingButton-outlinedStyles applied to the root element if variant="outlined".
outlinedInherit.MuiLoadingButton-outlinedInheritStyles applied to the root element if variant="outlined" and color="inherit".
outlinedPrimary.MuiLoadingButton-outlinedPrimaryStyles applied to the root element if variant="outlined" and color="primary".
outlinedSecondary.MuiLoadingButton-outlinedSecondaryStyles applied to the root element if variant="outlined" and color="secondary".
outlinedSuccess.MuiLoadingButton-outlinedSuccessStyles applied to the root element if variant="outlined" and color="success".
outlinedError.MuiLoadingButton-outlinedErrorStyles applied to the root element if variant="outlined" and color="error".
outlinedInfo.MuiLoadingButton-outlinedInfoStyles applied to the root element if variant="outlined" and color="info".
outlinedWarning.MuiLoadingButton-outlinedWarningStyles applied to the root element if variant="outlined" and color="warning".
contained.MuiLoadingButton-containedStyles applied to the root element if variant="contained".
containedInherit.MuiLoadingButton-containedInheritStyles applied to the root element if variant="contained" and color="inherit".
containedPrimary.MuiLoadingButton-containedPrimaryStyles applied to the root element if variant="contained" and color="primary".
containedSecondary.MuiLoadingButton-containedSecondaryStyles applied to the root element if variant="contained" and color="secondary".
containedSuccess.MuiLoadingButton-containedSuccessStyles applied to the root element if variant="contained" and color="success".
containedInfo.MuiLoadingButton-containedInfoStyles applied to the root element if variant="contained" and color="info".
containedError.MuiLoadingButton-containedErrorStyles applied to the root element if variant="contained" and color="error".
containedWarning.MuiLoadingButton-containedWarningStyles applied to the root element if variant="contained" and color="warning".
disableElevation.MuiLoadingButton-disableElevationStyles applied to the root element if disableElevation={true}.
focusVisible.Mui-focusVisibleState class applied to the ButtonBase root element if the button is keyboard focused.
disabled.Mui-disabledState class applied to the root element if disabled={true}.
colorInherit.MuiLoadingButton-colorInheritStyles applied to the root element if color="inherit".
textSizeSmall.MuiLoadingButton-textSizeSmallStyles applied to the root element if size="small" and variant="text".
textSizeMedium.MuiLoadingButton-textSizeMediumStyles applied to the root element if size="medium" and variant="text".
textSizeLarge.MuiLoadingButton-textSizeLargeStyles applied to the root element if size="large" and variant="text".
outlinedSizeSmall.MuiLoadingButton-outlinedSizeSmallStyles applied to the root element if size="small" and variant="outlined".
outlinedSizeMedium.MuiLoadingButton-outlinedSizeMediumStyles applied to the root element if size="medium" and variant="outlined".
outlinedSizeLarge.MuiLoadingButton-outlinedSizeLargeStyles applied to the root element if size="large" and variant="outlined".
containedSizeSmall.MuiLoadingButton-containedSizeSmallStyles applied to the root element if size="small" and variant="contained".
containedSizeMedium.MuiLoadingButton-containedSizeMediumStyles applied to the root element if size="medium" and variant="contained".
containedSizeLarge.MuiLoadingButton-containedSizeLargeStyles applied to the root element if size="large" and variant="contained".
sizeSmall.MuiLoadingButton-sizeSmallStyles applied to the root element if size="small".
sizeMedium.MuiLoadingButton-sizeMediumStyles applied to the root element if size="medium".
sizeLarge.MuiLoadingButton-sizeLargeStyles applied to the root element if size="large".
fullWidth.MuiLoadingButton-fullWidthStyles applied to the root element if fullWidth={true}.
startIcon.MuiLoadingButton-startIconStyles applied to the startIcon element if supplied.
endIcon.MuiLoadingButton-endIconStyles applied to the endIcon element if supplied.
iconSizeSmall.MuiLoadingButton-iconSizeSmallStyles applied to the icon element if supplied and size="small".
iconSizeMedium.MuiLoadingButton-iconSizeMediumStyles applied to the icon element if supplied and size="medium".
iconSizeLarge.MuiLoadingButton-iconSizeLargeStyles applied to the icon element if supplied and size="large".
loading.MuiLoadingButton-loadingStyles applied to the root element if loading={true}.
loadingIndicator.MuiLoadingButton-loadingIndicatorStyles applied to the loadingIndicator element.
loadingIndicatorCenter.MuiLoadingButton-loadingIndicatorCenterStyles applied to the loadingIndicator element if loadingPosition="center".
loadingIndicatorStart.MuiLoadingButton-loadingIndicatorStartStyles applied to the loadingIndicator element if loadingPosition="start".
loadingIndicatorEnd.MuiLoadingButton-loadingIndicatorEndStyles applied to the loadingIndicator element if loadingPosition="end".
endIconLoadingEnd.MuiLoadingButton-endIconLoadingEndStyles applied to the endIcon element if loading={true} and loadingPosition="end".
startIconLoadingStart.MuiLoadingButton-startIconLoadingStartStyles applied to the startIcon element if loading={true} and loadingPosition="start".

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