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 component. | |
| classes | object | Override or extend the styles applied to the component. See CSS API below for more details. | |
| disabled | bool | false | If true, the component is disabled. |
| loading | bool | false | If true, the loading indicator is shown. |
| loadingIndicator | node | <CircularProgress color="inherit" size={16} /> | Element placed before the children if the button is in loading state. |
| loadingPosition | 'start' | 'end' | 'center' | 'center' | The loading 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. |
| loading | .MuiLoadingButton-loading | Styles applied to the root element if loading={true}. |
| loadingIndicator | .MuiLoadingButton-loadingIndicator | Styles applied to the loadingIndicator element. |
| loadingIndicatorCenter | .MuiLoadingButton-loadingIndicatorCenter | Styles applied to the loadingIndicator element if loadingPosition="center". |
| loadingIndicatorStart | .MuiLoadingButton-loadingIndicatorStart | Styles applied to the loadingIndicator element if loadingPosition="start". |
| loadingIndicatorEnd | .MuiLoadingButton-loadingIndicatorEnd | Styles applied to the loadingIndicator element if loadingPosition="end". |
| endIconLoadingEnd | .MuiLoadingButton-endIconLoadingEnd | Styles applied to the endIcon element if loading={true} and loadingPosition="end". |
| startIconLoadingStart | .MuiLoadingButton-startIconLoadingStart | Styles applied to the startIcon element if loading={true} and loadingPosition="start". |
| labelLoadingCenter | .MuiLoadingButton-labelLoadingCenter | Styles applied to the label element if loading={true} and loadingPosition="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.