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';Component name
The nameMuiLoadingButton can be used when providing default props or style overrides in the theme.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).
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 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 using one of these customization options:
- With a rule name of the
classesobject prop. - With a global class name.
- With a theme and an
styleOverridesproperty.