Skip to content

LoadingButton API

The API documentation of the LoadingButton React component. Learn more about the props and the CSS customization points.

Import

import LoadingButton from '@material-ui/lab/LoadingButton';
// or
import { LoadingButton } from '@material-ui/lab';

You can learn more about the difference by reading this guide.

Component name

The MuiLoadingButton name can be used for providing default props or style overrides at the theme level.

Props

Name Type Default Description
children node The content of the button.
classes object Override or extend the styles applied to the component. See CSS API below for more details.
disabled bool false If true, the button is disabled.
pending bool false If true, the pending indicator is shown.
pendingIndicator node <CircularProgress color="inherit" size={16} /> Element placed before the children if the button is in pending state.
pendingPosition 'start'
| 'end'
| 'center'
'center' The pending indicator can be positioned on the start, end, or the center of the button.

The ref is forwarded to the root element.

Any other props supplied will be provided to the root element (Button).

CSS

Rule name Global class Description
root .MuiLoadingButton-root Styles applied to the root element.
pending .MuiLoadingButton-pending Styles applied to the root element if pending={true}.
pendingIndicator .MuiLoadingButton-pendingIndicator Styles applied to the pendingIndicator element.
pendingIndicatorCenter .MuiLoadingButton-pendingIndicatorCenter Styles applied to the pendingIndicator element if pendingPosition="center".
pendingIndicatorStart .MuiLoadingButton-pendingIndicatorStart Styles applied to the pendingIndicator element if pendingPosition="start".
pendingIndicatorEnd .MuiLoadingButton-pendingIndicatorEnd Styles applied to the pendingIndicator element if pendingPosition="end".
endIconPendingEnd .MuiLoadingButton-endIconPendingEnd Styles applied to the endIcon element if pending={true} and pendingPosition="end".
startIconPendingStart .MuiLoadingButton-startIconPendingStart Styles applied to the startIcon element if pending={true} and pendingPosition="start".
labelPendingCenter .MuiLoadingButton-labelPendingCenter Styles applied to the label element if pending={true} and pendingPosition="center".

You can override the style of the component thanks to one of these customization points:

If that's not sufficient, you can check the implementation of the component for more detail.

Inheritance

The props of the Button component are also available. You can take advantage of this behavior to target nested components.

Demos