警示API
React Alert 組件的 API 參考文件。了解此匯出模組的 props、CSS 和其他 API。
示範
匯入
import Alert from '@mui/joy/Alert';
// or
import { Alert } from '@mui/joy';
閱讀這篇關於最小化 bundle 大小的指南,以了解差異。
原生組件的 props 也可用。
名稱 | 類型 | 預設 | 描述 |
---|---|---|---|
color | 'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string | 'neutral' | 組件的顏色。它支援適用於此組件的那些主題顏色。 若要了解如何新增您自己的顏色,請查看「主題組件—延伸顏色」。 |
component | elementType | - | 用於根節點的組件。可以是字串 (用於 HTML 元素) 或組件。 |
endDecorator | node | - | 放置在子元素之後的元素。 |
invertedColors | bool | false | 如果為 |
role | string | 'alert' | 元素的 ARIA role 屬性。 |
size | 'sm' | 'md' | 'lg' | string | 'md' | 組件的大小。 若要了解如何將自訂大小新增至組件,請查看「主題組件—延伸大小」。 |
slotProps | { endDecorator?: func | object, root?: func | object, startDecorator?: func | object } | {} | 用於每個 slot 內部的 props。 |
slots | { endDecorator?: elementType, root?: elementType, startDecorator?: elementType } | {} | 用於每個 slot 內部的組件。 有關更多詳細資訊,請參閱下方的「Slots API」。 |
startDecorator | node | - | 放置在子元素之前的元素。 |
sx | Array<func | object | bool> | func | object | - | 系統 prop,可讓您定義系統覆寫以及其他 CSS 樣式。 有關更多詳細資訊,請參閱 |
variant | 'outlined' | 'plain' | 'soft' | 'solid' | string | 'soft' | 要使用的全域 variant。 若要了解如何新增您自己的 variant,請查看「主題組件—延伸 variant」。 |
ref
會轉發到根元素。主題預設 props
您可以使用 JoyAlert
來變更此組件的預設 props (使用主題)。
若要了解如何自訂 slot,請查看「覆寫組件結構」指南。
Slot 名稱 | 類別名稱 | 預設組件 | 描述 |
---|---|---|---|
root | .MuiAlert-root | 'div' | 呈現根的組件。 |
startDecorator | startDecorator | .MuiAlert-startDecorator | 'span' |
endDecorator | endDecorator | .MuiAlert-startDecorator | 呈現結束裝飾器的組件。 |
這些類別名稱對於使用 CSS 設定樣式很有用。當觸發特定狀態時,它們會套用至組件的 slots。
類別名稱 | 規則名稱 | 描述 |
---|---|---|
.MuiAlert-colorContext | colorContext | 當觸發顏色反轉時,套用至根元素的類別名稱。 |
.MuiAlert-colorDanger | colorDanger | 如果 color="danger" ,則套用至根元素的類別名稱。 |
.MuiAlert-colorNeutral | colorNeutral | 如果 color="neutral" ,則套用至根元素的類別名稱。 |
.MuiAlert-colorPrimary | colorPrimary | 如果 color="primary" ,則套用至根元素的類別名稱。 |
.MuiAlert-colorSuccess | colorSuccess | 如果 color="success" ,則套用至根元素的類別名稱。 |
.MuiAlert-colorWarning | colorWarning | 如果 color="warning" ,則套用至根元素的類別名稱。 |
.MuiAlert-sizeLg | sizeLg | 如果 size="lg" ,則套用至根元素的類別名稱。 |
.MuiAlert-sizeMd | sizeMd | 如果 size="md" ,則套用至根元素的類別名稱。 |
.MuiAlert-sizeSm | sizeSm | 如果 size="sm" ,則套用至根元素的類別名稱。 |
.MuiAlert-variantOutlined | variantOutlined | 如果 variant="outlined" ,則套用至根元素的類別名稱。 |
.MuiAlert-variantPlain | variantPlain | 如果 variant="plain" ,則套用至根元素的類別名稱。 |
.MuiAlert-variantSoft | variantSoft | 如果 variant="soft" ,則套用至根元素的類別名稱。 |
.MuiAlert-variantSolid | variantSolid | 如果 variant="solid" ,則套用至根元素的類別名稱。 |
您可以使用下列其中一種自訂選項來覆寫組件的樣式
- 使用全域類別名稱。
- 使用規則名稱作為自訂主題中組件的
styleOverrides
屬性的一部分。
原始碼
如果您在此頁面中找不到資訊,請考慮查看組件的實作程式碼以取得更多詳細資訊。