ChipAPI
React Chip 元件的 API 參考文件。瞭解此匯出模組的 props、CSS 和其他 API。
示範
匯入
import Chip from '@mui/material/Chip';
// or
import { Chip } from '@mui/material';
若要瞭解差異,請閱讀此關於最小化 bundle 大小的指南。
Chip 以小方塊表示複雜的實體,例如聯絡人。
原生元件的 props 也可用。
名稱 | 類型 | 預設 | 描述 |
---|---|---|---|
avatar | element | - | 要顯示的 Avatar 元素。 |
children | unsupportedProp | - | 不支援此 prop。如果您需要變更 children 結構,請使用 |
classes | object | - | 覆寫或擴充套用至元件的樣式。 如需更多詳細資訊,請參閱下方的CSS 類別 API。 |
clickable | bool | - | 如果 |
color | 'default' | 'primary' | 'secondary' | 'error' | 'info' | 'success' | 'warning' | string | 'default' | 元件的顏色。它同時支援預設和自訂主題顏色,可以按照調色盤自訂指南中所示的方式新增。 |
component | elementType | - | 用於根節點的元件。字串(用於 HTML 元素)或元件。 |
deleteIcon | element | - | 覆寫預設的刪除圖示元素。僅在設定 |
disabled | bool | false | 如果 |
icon | element | - | 圖示元素。 |
label | node | - | 元件的內容。 |
onDelete | func | - | 當點擊刪除圖示時觸發的回呼。如果設定,將會顯示刪除圖示。 |
size | 'medium' | 'small' | string | 'medium' | 元件的大小。 |
skipFocusWhenDisabled | bool | false | 如果 |
sx | Array<func | object | bool> | func | object | - | 系統 prop,允許定義系統覆寫以及額外的 CSS 樣式。 如需更多詳細資訊,請參閱 `sx` 頁面。 |
variant | 'filled' | 'outlined' | string | 'filled' | 要使用的 variant。 |
ref
轉發到根元素。主題預設 props
您可以使用 MuiChip
透過主題變更此元件的預設 props。
這些類別名稱對於使用 CSS 設定樣式很有用。當觸發特定狀態時,它們會套用至元件的 slot。
類別名稱 | 規則名稱 | 描述 |
---|---|---|
.Mui-disabled | 如果 disabled={true} ,則套用至根元素的狀態類別。 | |
.Mui-focusVisible | 如果鍵盤聚焦,則套用至根元素的狀態類別。 | |
.MuiChip-avatar | avatar | 套用至 avatar 元素的樣式。 |
.MuiChip-avatarColorPrimary | avatarColorPrimary | 如果 color="primary" ,則套用至 avatar 元素的樣式。 |
.MuiChip-avatarColorSecondary | avatarColorSecondary | 如果 color="secondary" ,則套用至 avatar 元素的樣式。 |
.MuiChip-avatarMedium | avatarMedium | 如果 size="medium" ,則套用至 avatar 元素的樣式。 |
.MuiChip-avatarSmall | avatarSmall | 如果 size="small" ,則套用至 avatar 元素的樣式。 |
.MuiChip-clickable | clickable | 如果已定義 onClick 或 clickable={true} ,則套用至根元素的樣式。 |
.MuiChip-clickableColorPrimary | clickableColorPrimary | 如果已定義 onClick 和 color="primary" 或 clickable={true} ,則套用至根元素的樣式。 |
.MuiChip-clickableColorSecondary | clickableColorSecondary | 如果已定義 onClick 和 color="secondary" 或 clickable={true} ,則套用至根元素的樣式。 |
.MuiChip-colorDefault | colorDefault | 如果 color="default" ,則套用至根元素的樣式。 |
.MuiChip-colorError | colorError | 如果 color="error" ,則套用至根元素的樣式。 |
.MuiChip-colorInfo | colorInfo | 如果 color="info" ,則套用至根元素的樣式。 |
.MuiChip-colorPrimary | colorPrimary | 如果 color="primary" ,則套用至根元素的樣式。 |
.MuiChip-colorSecondary | colorSecondary | 如果 color="secondary" ,則套用至根元素的樣式。 |
.MuiChip-colorSuccess | colorSuccess | 如果 color="success" ,則套用至根元素的樣式。 |
.MuiChip-colorWarning | colorWarning | 如果 color="warning" ,則套用至根元素的樣式。 |
.MuiChip-deletable | deletable | 如果已定義 onDelete ,則套用至根元素的樣式。 |
.MuiChip-deletableColorPrimary | deletableColorPrimary | 如果已定義 onDelete 和 color="primary" ,則套用至根元素的樣式。 |
.MuiChip-deletableColorSecondary | deletableColorSecondary | 如果已定義 onDelete 和 color="secondary" ,則套用至根元素的樣式。 |
.MuiChip-deleteIcon | deleteIcon | 套用至 deleteIcon 元素的樣式。 |
.MuiChip-deleteIconColorPrimary | deleteIconColorPrimary | 如果 color="primary" ,則套用至 deleteIcon 元素的樣式。 |
.MuiChip-deleteIconColorSecondary | deleteIconColorSecondary | 如果 color="secondary" ,則套用至 deleteIcon 元素的樣式。 |
.MuiChip-deleteIconFilledColorPrimary | deleteIconFilledColorPrimary | 如果 color="primary" 和 variant="filled" ,則套用至 deleteIcon 元素的樣式。 |
.MuiChip-deleteIconFilledColorSecondary | deleteIconFilledColorSecondary | 如果 color="secondary" 和 variant="filled" ,則套用至 deleteIcon 元素的樣式。 |
.MuiChip-deleteIconMedium | deleteIconMedium | 如果 size="medium" ,則套用至 deleteIcon 元素的樣式。 |
.MuiChip-deleteIconOutlinedColorPrimary | deleteIconOutlinedColorPrimary | 如果 color="primary" 和 variant="outlined" ,則套用至 deleteIcon 元素的樣式。 |
.MuiChip-deleteIconOutlinedColorSecondary | deleteIconOutlinedColorSecondary | 如果 color="secondary" 和 variant="outlined" ,則套用至 deleteIcon 元素的樣式。 |
.MuiChip-deleteIconSmall | deleteIconSmall | 如果 size="small" ,則套用至 deleteIcon 元素的樣式。 |
.MuiChip-filled | filled | 如果 variant="filled" ,則套用至根元素的樣式。 |
.MuiChip-filledPrimary | filledPrimary | 如果 variant="filled" 和 color="primary" ,則套用至根元素的樣式。 |
.MuiChip-filledSecondary | filledSecondary | 如果 variant="filled" 和 color="secondary" ,則套用至根元素的樣式。 |
.MuiChip-icon | icon | 套用至 icon 元素的樣式。 |
.MuiChip-iconColorPrimary | iconColorPrimary | 如果 color="primary" ,則套用至 icon 元素的樣式。 |
.MuiChip-iconColorSecondary | iconColorSecondary | 如果 color="secondary" ,則套用至 icon 元素的樣式。 |
.MuiChip-iconMedium | iconMedium | 如果 size="medium" ,則套用至 icon 元素的樣式。 |
.MuiChip-iconSmall | iconSmall | 如果 size="small" ,則套用至 icon 元素的樣式。 |
.MuiChip-label | label | 套用至 label span 元素的樣式。 |
.MuiChip-labelMedium | labelMedium | 如果 size="medium" ,則套用至 label span 元素的樣式。 |
.MuiChip-labelSmall | labelSmall | 如果 size="small" ,則套用至 label span 元素的樣式。 |
.MuiChip-outlined | outlined | 如果 variant="outlined" ,則套用至根元素的樣式。 |
.MuiChip-outlinedPrimary | outlinedPrimary | 如果 variant="outlined" 和 color="primary" ,則套用至根元素的樣式。 |
.MuiChip-outlinedSecondary | outlinedSecondary | 如果 variant="outlined" 和 color="secondary" ,則套用至根元素的樣式。 |
.MuiChip-root | root | 套用至根元素的樣式。 |
.MuiChip-sizeMedium | sizeMedium | 如果 size="medium" ,則套用至根元素的樣式。 |
.MuiChip-sizeSmall | sizeSmall | 如果 size="small" ,則套用至根元素的樣式。 |
您可以使用下列其中一個自訂選項來覆寫元件的樣式
- 使用全域類別名稱。
- 在自訂主題中使用規則名稱作為元件的
styleOverrides
屬性的一部分。
原始碼
如果您在此頁面中找不到資訊,請考慮查看元件的實作以取得更多詳細資訊。