跳到内容

加载按钮API

React LoadingButton 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。

演示

导入

import LoadingButton from '@mui/lab/LoadingButton';
// or
import { LoadingButton } from '@mui/lab';

通过阅读这篇关于最小化包大小的指南来了解差异。

Props

也可使用Button组件的 Props。

名称类型默认值描述
children节点-

组件的内容。

classes对象-

覆盖或扩展应用于组件的样式。

有关详细信息,请参阅下面的CSS 类 API

disabled布尔值false

如果为true,则禁用该组件。

loading布尔值false

如果为true,则显示加载指示器并禁用按钮。

loadingIndicator节点<CircularProgress color="inherit" size={16} />

如果按钮处于加载状态,则放置在子元素之前的元素。该节点应包含一个带有role="progressbar"且具有可访问名称的元素。默认情况下,我们会渲染一个由按钮本身标记的CircularProgress

loadingPosition'start'
| 'end'
| 'center'
'center'

加载指示器可以位于按钮的开始、结束或中心位置。

sx数组<函数
| 对象
| 布尔值>
| 函数
| 对象
-

允许定义系统覆盖以及其他 CSS 样式的系统 prop。

有关详细信息,请参阅`sx` 页面

variant'contained'
| 'outlined'
| 'text'
| 字符串
'text'

要使用的变体。

ref 被转发到根元素。

继承

尽管上面没有明确记录,但Button组件的 props 也可在 LoadingButton 中使用。您可以利用这一点来定位嵌套组件

主题默认 props

您可以使用 MuiLoadingButton 使用主题来更改此组件的默认 props。

CSS 类

这些类名对于使用 CSS 设置样式非常有用。当触发特定状态时,它们将应用于组件的插槽。

类名规则名称描述
.Mui-disabled如果 disabled={true},则应用于根元素的状态类。
.Mui-focusVisible如果按钮是通过键盘聚焦的,则应用于 ButtonBase 根元素的状态类。
.MuiLoadingButton-colorErrorcolorError如果 color="error",则应用于根元素的样式。
.MuiLoadingButton-colorInfocolorInfo如果 color="info",则应用于根元素的样式。
.MuiLoadingButton-colorInheritcolorInherit如果 color="inherit",则应用于根元素的样式。
.MuiLoadingButton-colorPrimarycolorPrimary如果 color="primary",则应用于根元素的样式。
.MuiLoadingButton-colorSecondarycolorSecondary如果 color="secondary",则应用于根元素的样式。
.MuiLoadingButton-colorSuccesscolorSuccess如果 color="success",则应用于根元素的样式。
.MuiLoadingButton-colorWarningcolorWarning如果 color="warning",则应用于根元素的样式。
.MuiLoadingButton-containedcontained如果 variant="contained",则应用于根元素的样式。
.MuiLoadingButton-containedErrorcontainedError如果 variant="contained"color="error",则应用于根元素的样式。
.MuiLoadingButton-containedInfocontainedInfo如果 variant="contained"color="info",则应用于根元素的样式。
.MuiLoadingButton-containedInheritcontainedInherit如果 variant="contained"color="inherit",则应用于根元素的样式。
.MuiLoadingButton-containedPrimarycontainedPrimary如果 variant="contained"color="primary",则应用于根元素的样式。
.MuiLoadingButton-containedSecondarycontainedSecondary如果 variant="contained"color="secondary",则应用于根元素的样式。
.MuiLoadingButton-containedSizeLargecontainedSizeLarge如果 size="large"variant="contained",则应用于根元素的样式。
.MuiLoadingButton-containedSizeMediumcontainedSizeMedium如果 size="medium"variant="contained",则应用于根元素的样式。
.MuiLoadingButton-containedSizeSmallcontainedSizeSmall如果 size="small"variant="contained",则应用于根元素的样式。
.MuiLoadingButton-containedSuccesscontainedSuccess如果 variant="contained"color="success",则应用于根元素的样式。
.MuiLoadingButton-containedWarningcontainedWarning如果 variant="contained"color="warning",则应用于根元素的样式。
.MuiLoadingButton-disableElevationdisableElevationdisableElevation={true} 时,应用于根元素的样式。
.MuiLoadingButton-endIconendIcon如果提供了 endIcon 元素,则应用于该元素的样式。
.MuiLoadingButton-endIconLoadingEndendIconLoadingEndloading={true}loadingPosition="end" 时,应用于 endIcon 元素的样式。
.MuiLoadingButton-fullWidthfullWidthfullWidth={true} 时,应用于根元素的样式。
.MuiLoadingButton-iconicon如果提供了 icon 元素,则应用于该元素的样式
.MuiLoadingButton-iconSizeLargeiconSizeLarge如果提供了 icon 元素且 size="large",则应用于该元素的样式。
.MuiLoadingButton-iconSizeMediumiconSizeMedium如果提供了 icon 元素且 size="medium",则应用于该元素的样式。
.MuiLoadingButton-iconSizeSmalliconSizeSmall如果提供了 icon 元素且 size="small",则应用于该元素的样式。
.MuiLoadingButton-labellabel应用于包裹子元素的 span 元素的样式。
.MuiLoadingButton-loadingloadingloading={true} 时,应用于根元素的样式。
.MuiLoadingButton-loadingIndicatorloadingIndicator应用于 loadingIndicator 元素的样式。
.MuiLoadingButton-loadingIndicatorCenterloadingIndicatorCenterloadingPosition="center" 时,应用于 loadingIndicator 元素的样式。
.MuiLoadingButton-loadingIndicatorEndloadingIndicatorEndloadingPosition="end" 时,应用于 loadingIndicator 元素的样式。
.MuiLoadingButton-loadingIndicatorStartloadingIndicatorStartloadingPosition="start" 时,应用于 loadingIndicator 元素的样式。
.MuiLoadingButton-outlinedoutlinedvariant="outlined" 时,应用于根元素的样式。
.MuiLoadingButton-outlinedErroroutlinedErrorvariant="outlined"color="error" 时,应用于根元素的样式。
.MuiLoadingButton-outlinedInfooutlinedInfovariant="outlined"color="info" 时,应用于根元素的样式。
.MuiLoadingButton-outlinedInheritoutlinedInheritvariant="outlined"color="inherit" 时,应用于根元素的样式。
.MuiLoadingButton-outlinedPrimaryoutlinedPrimaryvariant="outlined"color="primary" 时,应用于根元素的样式。
.MuiLoadingButton-outlinedSecondaryoutlinedSecondaryvariant="outlined"color="secondary" 时,应用于根元素的样式。
.MuiLoadingButton-outlinedSizeLargeoutlinedSizeLargesize="large"variant="outlined" 时,应用于根元素的样式。
.MuiLoadingButton-outlinedSizeMediumoutlinedSizeMediumsize="medium"variant="outlined" 时,应用于根元素的样式。
.MuiLoadingButton-outlinedSizeSmalloutlinedSizeSmallsize="small"variant="outlined" 时,应用于根元素的样式。
.MuiLoadingButton-outlinedSuccessoutlinedSuccessvariant="outlined"color="success" 时,应用于根元素的样式。
.MuiLoadingButton-outlinedWarningoutlinedWarningvariant="outlined"color="warning" 时,应用于根元素的样式。
.MuiLoadingButton-rootroot应用于根元素的样式。
.MuiLoadingButton-sizeLargesizeLargesize="large" 时,应用于根元素的样式。
.MuiLoadingButton-sizeMediumsizeMediumsize="medium" 时,应用于根元素的样式。
.MuiLoadingButton-sizeSmallsizeSmallsize="small" 时,应用于根元素的样式。
.MuiLoadingButton-startIconstartIcon如果提供了 startIcon 元素,则应用于该元素的样式。
.MuiLoadingButton-startIconLoadingStartstartIconLoadingStartloading={true}loadingPosition="start" 时,应用于 startIcon 元素的样式。
.MuiLoadingButton-texttextvariant="text" 时,应用于根元素的样式。
.MuiLoadingButton-textErrortextErrorvariant="text"color="error" 时,应用于根元素的样式。
.MuiLoadingButton-textInfotextInfovariant="text"color="info" 时,应用于根元素的样式。
.MuiLoadingButton-textInherittextInheritvariant="text"color="inherit" 时,应用于根元素的样式。
.MuiLoadingButton-textPrimarytextPrimaryvariant="text"color="primary" 时,应用于根元素的样式。
.MuiLoadingButton-textSecondarytextSecondaryvariant="text"color="secondary" 时,应用于根元素的样式。
.MuiLoadingButton-textSizeLargetextSizeLargesize="large"variant="text" 时,应用于根元素的样式。
.MuiLoadingButton-textSizeMediumtextSizeMediumsize="medium"variant="text" 时,应用于根元素的样式。
.MuiLoadingButton-textSizeSmalltextSizeSmallsize="small"variant="text" 时,应用于根元素的样式。
.MuiLoadingButton-textSuccesstextSuccessvariant="text"color="success" 时,应用于根元素的样式。
.MuiLoadingButton-textWarningtextWarning如果 variant="text"color="warning",则应用于根元素的样式。

您可以使用以下自定义选项之一来覆盖组件的样式

源代码

如果您在此页面中没有找到信息,请查看组件的实现以获取更多详细信息。