LoadingButton API
API documentation for the React LoadingButton component. Learn about the available props and the CSS API.
Import
import LoadingButton from '@mui/lab/LoadingButton';
// or
import { LoadingButton } from '@mui/lab';
Component name
The nameMuiLoadingButton
can be used when providing default props or style overrides in the theme.Props
Props of the Button component are also available.
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. |
sx | func | object | The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details. |
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 name | Global class | Description |
---|---|---|
root | .MuiLoadingButton-root | Styles applied to the root element. |
text | .MuiLoadingButton-text | Styles applied to the root element if variant="text" . |
textInherit | .MuiLoadingButton-textInherit | Styles applied to the root element if variant="text" and color="inherit" . |
textPrimary | .MuiLoadingButton-textPrimary | Styles applied to the root element if variant="text" and color="primary" . |
textSecondary | .MuiLoadingButton-textSecondary | Styles applied to the root element if variant="text" and color="secondary" . |
outlined | .MuiLoadingButton-outlined | Styles applied to the root element if variant="outlined" . |
outlinedInherit | .MuiLoadingButton-outlinedInherit | Styles applied to the root element if variant="outlined" and color="inherit" . |
outlinedPrimary | .MuiLoadingButton-outlinedPrimary | Styles applied to the root element if variant="outlined" and color="primary" . |
outlinedSecondary | .MuiLoadingButton-outlinedSecondary | Styles applied to the root element if variant="outlined" and color="secondary" . |
contained | .MuiLoadingButton-contained | Styles applied to the root element if variant="contained" . |
containedInherit | .MuiLoadingButton-containedInherit | Styles applied to the root element if variant="contained" and color="inherit" . |
containedPrimary | .MuiLoadingButton-containedPrimary | Styles applied to the root element if variant="contained" and color="primary" . |
containedSecondary | .MuiLoadingButton-containedSecondary | Styles applied to the root element if variant="contained" and color="secondary" . |
disableElevation | .MuiLoadingButton-disableElevation | Styles applied to the root element if disableElevation={true} . |
focusVisible | .Mui-focusVisible | State class applied to the ButtonBase root element if the button is keyboard focused. |
disabled | .Mui-disabled | State class applied to the root element if disabled={true} . |
colorInherit | .MuiLoadingButton-colorInherit | Styles applied to the root element if color="inherit" . |
textSizeSmall | .MuiLoadingButton-textSizeSmall | Styles applied to the root element if size="small" and variant="text" . |
textSizeMedium | .MuiLoadingButton-textSizeMedium | Styles applied to the root element if size="medium" and variant="text" . |
textSizeLarge | .MuiLoadingButton-textSizeLarge | Styles applied to the root element if size="large" and variant="text" . |
outlinedSizeSmall | .MuiLoadingButton-outlinedSizeSmall | Styles applied to the root element if size="small" and variant="outlined" . |
outlinedSizeMedium | .MuiLoadingButton-outlinedSizeMedium | Styles applied to the root element if size="medium" and variant="outlined" . |
outlinedSizeLarge | .MuiLoadingButton-outlinedSizeLarge | Styles applied to the root element if size="large" and variant="outlined" . |
containedSizeSmall | .MuiLoadingButton-containedSizeSmall | Styles applied to the root element if size="small" and variant="contained" . |
containedSizeMedium | .MuiLoadingButton-containedSizeMedium | Styles applied to the root element if size="small" and variant="contained" . |
containedSizeLarge | .MuiLoadingButton-containedSizeLarge | Styles applied to the root element if size="large" and variant="contained" . |
sizeSmall | .MuiLoadingButton-sizeSmall | Styles applied to the root element if size="small" . |
sizeMedium | .MuiLoadingButton-sizeMedium | Styles applied to the root element if size="medium" . |
sizeLarge | .MuiLoadingButton-sizeLarge | Styles applied to the root element if size="large" . |
fullWidth | .MuiLoadingButton-fullWidth | Styles applied to the root element if fullWidth={true} . |
startIcon | .MuiLoadingButton-startIcon | Styles applied to the startIcon element if supplied. |
endIcon | .MuiLoadingButton-endIcon | Styles applied to the endIcon element if supplied. |
iconSizeSmall | .MuiLoadingButton-iconSizeSmall | Styles applied to the icon element if supplied and size="small" . |
iconSizeMedium | .MuiLoadingButton-iconSizeMedium | Styles applied to the icon element if supplied and size="medium" . |
iconSizeLarge | .MuiLoadingButton-iconSizeLarge | Styles applied to the icon element if supplied and size="large" . |
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" . |
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverrides
property in a custom theme.