載入按鈕API
React LoadingButton 元件的 API 參考文件。瞭解此匯出模組的屬性、CSS 和其他 API。
展示
導入
import LoadingButton from '@mui/lab/LoadingButton';
// or
import { LoadingButton } from '@mui/lab';
閱讀此最小化套件大小指南以了解差異。
Button 元件的屬性也適用。
名稱 | 類型 | 預設值 | 說明 |
---|---|---|---|
children | node | - | 元件的內容。 |
classes | object | - | 覆寫或擴展套用到元件的樣式。 有關更多詳細資訊,請參閱下面的 CSS 類別 API。 |
disabled | bool | false | 如果為 |
loading | bool | false | 如果為 |
loadingIndicator | node | <CircularProgress color="inherit" size={16} /> | 如果按鈕處於載入狀態,則放置在子項之前的元素。該節點應包含一個具有 |
loadingPosition | 'start' | 'end' | 'center' | 'center' | 載入指示器可以放置在按鈕的開頭、結尾或中央。 |
sx | Array<func | object | bool> | func | object | - | 系統屬性,允許定義系統覆寫以及其他 CSS 樣式。 有關更多詳細資訊,請參閱 `sx` 頁面。 |
variant | 'contained' | 'outlined' | 'text' | string | 'text' | 要使用的變體。 |
ref
會轉送至根元素。繼承
雖然上面沒有明確記載,但 Button 元件的屬性在 LoadingButton 中也可用。您可以利用這個優勢來 設定目標巢狀元件。
主題預設屬性
您可以使用 MuiLoadingButton
透過主題更改此元件的預設屬性。
這些類別名稱可用於 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" ,則套用至 icon 元素的樣式。 |
.MuiLoadingButton-iconSizeMedium | iconSizeMedium | 如果有提供 icon 元素且 size="medium" ,則套用至 icon 元素的樣式。 |
.MuiLoadingButton-iconSizeSmall | iconSizeSmall | 如果有提供 icon 元素且 size="small" ,則套用至 icon 元素的樣式。 |
.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
屬性 的一部分。
原始程式碼
如果您在此頁面中找不到資訊,請考慮查看元件的實作以取得更多詳細資訊。