Перейти к контенту

LoadingButton API

API documentation for the React LoadingButton component. Learn about the available props, and the CSS API.

Import

import LoadingButton from '@material-ui/lab/LoadingButton';
// or
import { LoadingButton } from '@material-ui/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

NameTypeDefaultDescription
childrennodeThe content of the button.
classesobjectOverride or extend the styles applied to the component. See CSS API below for more details.
disabledboolfalseIf true, the button is disabled.
pendingboolfalseIf true, the pending indicator is shown.
pendingIndicatornode<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).

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.
pending.MuiLoadingButton-pendingStyles applied to the root element if pending={true}.
pendingIndicator.MuiLoadingButton-pendingIndicatorStyles applied to the pendingIndicator element.
pendingIndicatorCenter.MuiLoadingButton-pendingIndicatorCenterStyles applied to the pendingIndicator element if pendingPosition="center".
pendingIndicatorStart.MuiLoadingButton-pendingIndicatorStartStyles applied to the pendingIndicator element if pendingPosition="start".
pendingIndicatorEnd.MuiLoadingButton-pendingIndicatorEndStyles applied to the pendingIndicator element if pendingPosition="end".
endIconPendingEnd.MuiLoadingButton-endIconPendingEndStyles applied to the endIcon element if pending={true} and pendingPosition="end".
startIconPendingStart.MuiLoadingButton-startIconPendingStartStyles applied to the startIcon element if pending={true} and pendingPosition="start".
labelPendingCenter.MuiLoadingButton-labelPendingCenterStyles applied to the label element if pending={true} and pendingPosition="center".

You can override the style of the component using one of these customization options: If that isn't sufficient, you can check the implementation of the component for more detail.

Demos