加载按钮API
React LoadingButton 组件的 API 参考文档。了解此导出模块的 props、CSS 和其他 API。
演示
导入
import LoadingButton from '@mui/lab/LoadingButton';
// or
import { LoadingButton } from '@mui/lab';
通过阅读这篇关于最小化包大小的指南来了解差异。
也可使用Button组件的 Props。
名称 | 类型 | 默认值 | 描述 |
---|---|---|---|
children | 节点 | - | 组件的内容。 |
classes | 对象 | - | 覆盖或扩展应用于组件的样式。 有关详细信息,请参阅下面的CSS 类 API。 |
disabled | 布尔值 | false | 如果为 |
loading | 布尔值 | false | 如果为 |
loadingIndicator | 节点 | <CircularProgress color="inherit" size={16} /> | 如果按钮处于加载状态,则放置在子元素之前的元素。该节点应包含一个带有 |
loadingPosition | 'start' | 'end' | 'center' | 'center' | 加载指示器可以位于按钮的开始、结束或中心位置。 |
sx | 数组<函数 | 对象 | 布尔值> | 函数 | 对象 | - | 允许定义系统覆盖以及其他 CSS 样式的系统 prop。 有关详细信息,请参阅`sx` 页面。 |
variant | 'contained' | 'outlined' | 'text' | 字符串 | 'text' | 要使用的变体。 |
ref
被转发到根元素。继承
尽管上面没有明确记录,但Button组件的 props 也可在 LoadingButton 中使用。您可以利用这一点来定位嵌套组件。
主题默认 props
您可以使用 MuiLoadingButton
使用主题来更改此组件的默认 props。
这些类名对于使用 CSS 设置样式非常有用。当触发特定状态时,它们将应用于组件的插槽。
类名 | 规则名称 | 描述 |
---|---|---|
.Mui-disabled | 如果 disabled={true} ,则应用于根元素的状态类。 | |
.Mui-focusVisible | 如果按钮是通过键盘聚焦的,则应用于 ButtonBase 根元素的状态类。 | |
.MuiLoadingButton-colorError | colorError | 如果 color="error" ,则应用于根元素的样式。 |
.MuiLoadingButton-colorInfo | colorInfo | 如果 color="info" ,则应用于根元素的样式。 |
.MuiLoadingButton-colorInherit | colorInherit | 如果 color="inherit" ,则应用于根元素的样式。 |
.MuiLoadingButton-colorPrimary | colorPrimary | 如果 color="primary" ,则应用于根元素的样式。 |
.MuiLoadingButton-colorSecondary | colorSecondary | 如果 color="secondary" ,则应用于根元素的样式。 |
.MuiLoadingButton-colorSuccess | colorSuccess | 如果 color="success" ,则应用于根元素的样式。 |
.MuiLoadingButton-colorWarning | colorWarning | 如果 color="warning" ,则应用于根元素的样式。 |
.MuiLoadingButton-contained | contained | 如果 variant="contained" ,则应用于根元素的样式。 |
.MuiLoadingButton-containedError | containedError | 如果 variant="contained" 且 color="error" ,则应用于根元素的样式。 |
.MuiLoadingButton-containedInfo | containedInfo | 如果 variant="contained" 且 color="info" ,则应用于根元素的样式。 |
.MuiLoadingButton-containedInherit | containedInherit | 如果 variant="contained" 且 color="inherit" ,则应用于根元素的样式。 |
.MuiLoadingButton-containedPrimary | containedPrimary | 如果 variant="contained" 且 color="primary" ,则应用于根元素的样式。 |
.MuiLoadingButton-containedSecondary | containedSecondary | 如果 variant="contained" 且 color="secondary" ,则应用于根元素的样式。 |
.MuiLoadingButton-containedSizeLarge | containedSizeLarge | 如果 size="large" 且 variant="contained" ,则应用于根元素的样式。 |
.MuiLoadingButton-containedSizeMedium | containedSizeMedium | 如果 size="medium" 且 variant="contained" ,则应用于根元素的样式。 |
.MuiLoadingButton-containedSizeSmall | containedSizeSmall | 如果 size="small" 且 variant="contained" ,则应用于根元素的样式。 |
.MuiLoadingButton-containedSuccess | containedSuccess | 如果 variant="contained" 且 color="success" ,则应用于根元素的样式。 |
.MuiLoadingButton-containedWarning | containedWarning | 如果 variant="contained" 且 color="warning" ,则应用于根元素的样式。 |
.MuiLoadingButton-disableElevation | disableElevation | 当 disableElevation={true} 时,应用于根元素的样式。 |
.MuiLoadingButton-endIcon | endIcon | 如果提供了 endIcon 元素,则应用于该元素的样式。 |
.MuiLoadingButton-endIconLoadingEnd | endIconLoadingEnd | 当 loading={true} 且 loadingPosition="end" 时,应用于 endIcon 元素的样式。 |
.MuiLoadingButton-fullWidth | fullWidth | 当 fullWidth={true} 时,应用于根元素的样式。 |
.MuiLoadingButton-icon | icon | 如果提供了 icon 元素,则应用于该元素的样式 |
.MuiLoadingButton-iconSizeLarge | iconSizeLarge | 如果提供了 icon 元素且 size="large" ,则应用于该元素的样式。 |
.MuiLoadingButton-iconSizeMedium | iconSizeMedium | 如果提供了 icon 元素且 size="medium" ,则应用于该元素的样式。 |
.MuiLoadingButton-iconSizeSmall | iconSizeSmall | 如果提供了 icon 元素且 size="small" ,则应用于该元素的样式。 |
.MuiLoadingButton-label | label | 应用于包裹子元素的 span 元素的样式。 |
.MuiLoadingButton-loading | loading | 当 loading={true} 时,应用于根元素的样式。 |
.MuiLoadingButton-loadingIndicator | loadingIndicator | 应用于 loadingIndicator 元素的样式。 |
.MuiLoadingButton-loadingIndicatorCenter | loadingIndicatorCenter | 当 loadingPosition="center" 时,应用于 loadingIndicator 元素的样式。 |
.MuiLoadingButton-loadingIndicatorEnd | loadingIndicatorEnd | 当 loadingPosition="end" 时,应用于 loadingIndicator 元素的样式。 |
.MuiLoadingButton-loadingIndicatorStart | loadingIndicatorStart | 当 loadingPosition="start" 时,应用于 loadingIndicator 元素的样式。 |
.MuiLoadingButton-outlined | outlined | 当 variant="outlined" 时,应用于根元素的样式。 |
.MuiLoadingButton-outlinedError | outlinedError | 当 variant="outlined" 且 color="error" 时,应用于根元素的样式。 |
.MuiLoadingButton-outlinedInfo | outlinedInfo | 当 variant="outlined" 且 color="info" 时,应用于根元素的样式。 |
.MuiLoadingButton-outlinedInherit | outlinedInherit | 当 variant="outlined" 且 color="inherit" 时,应用于根元素的样式。 |
.MuiLoadingButton-outlinedPrimary | outlinedPrimary | 当 variant="outlined" 且 color="primary" 时,应用于根元素的样式。 |
.MuiLoadingButton-outlinedSecondary | outlinedSecondary | 当 variant="outlined" 且 color="secondary" 时,应用于根元素的样式。 |
.MuiLoadingButton-outlinedSizeLarge | outlinedSizeLarge | 当 size="large" 且 variant="outlined" 时,应用于根元素的样式。 |
.MuiLoadingButton-outlinedSizeMedium | outlinedSizeMedium | 当 size="medium" 且 variant="outlined" 时,应用于根元素的样式。 |
.MuiLoadingButton-outlinedSizeSmall | outlinedSizeSmall | 当 size="small" 且 variant="outlined" 时,应用于根元素的样式。 |
.MuiLoadingButton-outlinedSuccess | outlinedSuccess | 当 variant="outlined" 且 color="success" 时,应用于根元素的样式。 |
.MuiLoadingButton-outlinedWarning | outlinedWarning | 当 variant="outlined" 且 color="warning" 时,应用于根元素的样式。 |
.MuiLoadingButton-root | root | 应用于根元素的样式。 |
.MuiLoadingButton-sizeLarge | sizeLarge | 当 size="large" 时,应用于根元素的样式。 |
.MuiLoadingButton-sizeMedium | sizeMedium | 当 size="medium" 时,应用于根元素的样式。 |
.MuiLoadingButton-sizeSmall | sizeSmall | 当 size="small" 时,应用于根元素的样式。 |
.MuiLoadingButton-startIcon | startIcon | 如果提供了 startIcon 元素,则应用于该元素的样式。 |
.MuiLoadingButton-startIconLoadingStart | startIconLoadingStart | 当 loading={true} 且 loadingPosition="start" 时,应用于 startIcon 元素的样式。 |
.MuiLoadingButton-text | text | 当 variant="text" 时,应用于根元素的样式。 |
.MuiLoadingButton-textError | textError | 当 variant="text" 且 color="error" 时,应用于根元素的样式。 |
.MuiLoadingButton-textInfo | textInfo | 当 variant="text" 且 color="info" 时,应用于根元素的样式。 |
.MuiLoadingButton-textInherit | textInherit | 当 variant="text" 且 color="inherit" 时,应用于根元素的样式。 |
.MuiLoadingButton-textPrimary | textPrimary | 当 variant="text" 且 color="primary" 时,应用于根元素的样式。 |
.MuiLoadingButton-textSecondary | textSecondary | 当 variant="text" 且 color="secondary" 时,应用于根元素的样式。 |
.MuiLoadingButton-textSizeLarge | textSizeLarge | 当 size="large" 且 variant="text" 时,应用于根元素的样式。 |
.MuiLoadingButton-textSizeMedium | textSizeMedium | 当 size="medium" 且 variant="text" 时,应用于根元素的样式。 |
.MuiLoadingButton-textSizeSmall | textSizeSmall | 当 size="small" 且 variant="text" 时,应用于根元素的样式。 |
.MuiLoadingButton-textSuccess | textSuccess | 当 variant="text" 且 color="success" 时,应用于根元素的样式。 |
.MuiLoadingButton-textWarning | textWarning | 如果 variant="text" 且 color="warning" ,则应用于根元素的样式。 |
您可以使用以下自定义选项之一来覆盖组件的样式
- 使用全局类名。
- 在自定义主题中使用规则名称作为组件的
styleOverrides
属性的一部分。
源代码
如果您在此页面中没有找到信息,请查看组件的实现以获取更多详细信息。