AutocompleteListboxAPI
React AutocompleteListbox 組件的 API 參考文檔。瞭解此導出模組的 props、CSS 和其他 API。
範例
Import
import AutocompleteListbox from '@mui/joy/AutocompleteListbox';
// or
import { AutocompleteListbox } from '@mui/joy';
閱讀關於最小化 bundle size 的指南,以瞭解它們之間的差異。
也提供原生組件的 Props。
名稱 | 類型 | 預設值 | 描述 |
---|---|---|---|
color | 'danger' | 'neutral' | 'primary' | 'success' | 'warning' | string | 'neutral' | 組件的顏色。它支援適用於此組件的那些主題顏色。 若要瞭解如何新增您自己的顏色,請查看主題組件 — 擴展顏色。 |
component | elementType | - | 用於根節點的組件。可以是使用 HTML 元素的字串或組件。 |
size | 'sm' | 'md' | 'lg' | 'md' | 組件的大小(影響其他巢狀 list* 組件)。 若要瞭解如何將自訂大小新增至組件,請查看主題組件 — 擴展尺寸。 |
slotProps | { root?: func | object } | {} | 用於每個內部 slot 的 props。 |
slots | { root?: elementType } | {} | 用於每個內部 slot 的組件。 請參閱下方Slots API 以瞭解更多詳細資訊。 |
sx | Array<func | object | bool> | func | object | - | 系統 prop,允許定義系統覆寫以及其他 CSS 樣式。 請參閱 `sx` 頁面以瞭解更多詳細資訊。 |
variant | 'contained' | 'light' | 'outlined' | 'text' | string | 'outlined' | 要使用的全域 variant。 若要瞭解如何新增您自己的 variant,請查看主題組件 — 擴展 variants。 |
ref
會轉發到根元素。主題預設 props
您可以使用 JoyAutocompleteListbox
透過主題變更此組件的預設 props。
若要瞭解如何自訂 slot,請查看覆寫組件結構指南。
Slot 名稱 | 類別名稱 | 預設組件 | 描述 |
---|---|---|---|
root | .MuiAutocompleteListbox-root | 'ul' | 呈現根的組件。 |
這些類別名稱對於使用 CSS 設定樣式很有用。當觸發特定狀態時,它們會套用至組件的 slot。
類別名稱 | 規則名稱 | 描述 |
---|---|---|
.MuiAutocompleteListbox-colorContext | colorContext | 當觸發顏色反轉時,套用至根元素的類別名稱。 |
.MuiAutocompleteListbox-colorDanger | colorDanger | 如果 color="danger" ,則套用至根元素的類別名稱。 |
.MuiAutocompleteListbox-colorNeutral | colorNeutral | 如果 color="neutral" ,則套用至根元素的類別名稱。 |
.MuiAutocompleteListbox-colorPrimary | colorPrimary | 如果 color="primary" ,則套用至根元素的類別名稱。 |
.MuiAutocompleteListbox-colorSuccess | colorSuccess | 如果 color="success" ,則套用至根元素的類別名稱。 |
.MuiAutocompleteListbox-colorWarning | colorWarning | 如果 color="warning" ,則套用至根元素的類別名稱。 |
.MuiAutocompleteListbox-sizeLg | sizeLg | 如果 size="lg" ,則套用至根元素的類別名稱。 |
.MuiAutocompleteListbox-sizeMd | sizeMd | 如果 size="md" ,則套用至根元素的類別名稱。 |
.MuiAutocompleteListbox-sizeSm | sizeSm | 如果 size="sm" ,則套用至根元素的類別名稱。 |
.MuiAutocompleteListbox-variantOutlined | variantOutlined | 如果 variant="outlined" ,則套用至根元素的類別名稱。 |
.MuiAutocompleteListbox-variantPlain | variantPlain | 如果 variant="plain" ,則套用至根元素的類別名稱。 |
.MuiAutocompleteListbox-variantSoft | variantSoft | 如果 variant="soft" ,則套用至根元素的類別名稱。 |
.MuiAutocompleteListbox-variantSolid | variantSolid | 如果 variant="solid" ,則套用至根元素的類別名稱。 |
您可以使用以下自訂選項之一覆寫組件的樣式
- 使用全域類別名稱。
- 在自訂主題中使用規則名稱作為組件
styleOverrides
屬性的一部分。
原始碼
如果您在本頁中找不到資訊,請考慮查看組件的實作以取得更多詳細資訊。