跳到主要內容
+

開關

開關是一種 UI 元素,可讓使用者在兩種狀態之間做選擇,最常見的是開啟/關閉。

useSwitch API

Import

import { useSwitch } from '@mui/base/useSwitch';
// or
import { useSwitch } from '@mui/base';

請閱讀此篇關於最小化套件大小的指南,以了解差異。

參數

名稱類型描述
checkedboolean

若為 true,元件會被核取。

defaultCheckedboolean

預設的核取狀態。當元件為非受控元件時使用。

disabledboolean

若為 true,元件會被停用。

onBlurReact.FocusEventHandler
onChangeReact.ChangeEventHandler<HTMLInputElement>

當狀態變更時觸發的回呼函式。

onFocusReact.FocusEventHandler
onFocusVisibleReact.FocusEventHandler
readOnlyboolean

若為 true,元件為唯讀。

requiredboolean

若為 trueinput 元素為必填。

回傳值

名稱類型描述
checkedboolean

若為 true,元件將會被核取。

disabledboolean

若為 true,元件將會被停用。

focusVisibleboolean

若為 true,表示元件正透過鍵盤取得焦點。

getInputProps(externalProps?: React.HTMLAttributes<HTMLInputElement>) => UseSwitchInputSlotProps

輸入框 slot props 的解析器。

inputRefReact.RefCallback<HTMLInputElement> | null

輸入框 slot DOM 節點的 Ref。

readOnlyboolean

若為 true,元件將為唯讀。