Switch切換開關

開關元件用來切換單一選項的開啟或關閉狀態，透過直覺的互動設計，讓使用者能輕鬆調整設定。

使用方法

按需引入元件：

import 'mdui/components/switch.js';

按需引入元件的 TypeScript 型別：

import type { Switch } from 'mdui/components/switch.js';

使用範例：

<mdui-switch></mdui-switch>

範例

選取狀態

當開關被選取時，checked 屬性的值為 true。你也可以透過加上 checked 屬性，使開關預設處於選取狀態。

<mdui-switch checked></mdui-switch>

原始碼

停用狀態

透過加上 disabled 屬性，可以停用開關元件。

<mdui-switch disabled></mdui-switch>
<mdui-switch disabled checked></mdui-switch>

原始碼

圖示

你可以透過 unchecked-icon 屬性來設定未選取狀態的 Material Icons 圖示，透過 checked-icon 屬性來設定選取狀態的 Material Icons 圖示。也可以透過 unchecked-icon 和 checked-icon slot 來自訂未選取和選取狀態的圖示元素。

<mdui-switch unchecked-icon="remove_moderator" checked-icon="verified_user"></mdui-switch>
<mdui-switch>
  <mdui-icon slot="unchecked-icon" name="remove_moderator"></mdui-icon>
  <mdui-icon slot="checked-icon" name="verified_user"></mdui-icon>
</mdui-switch>

原始碼

API

屬性

HTML 屬性	JavaScript 屬性	型別	預設值
`disabled`	`disabled`	`boolean`	`false`
是否為停用狀態
`checked`	`checked`	`boolean`	`false`
是否為選取狀態
	`defaultChecked`	`boolean`	`false`
預設選取狀態。在重設表單時，將重設為此狀態。此屬性只能透過 JavaScript 屬性設定
`unchecked-icon`	`uncheckedIcon`	`string`	-
未選取狀態的 Material Icons 圖示名。也可以透過 `slot="unchecked-icon"` 設定
`checked-icon`	`checkedIcon`	`string`	-
選取狀態的 Material Icons 圖示名。也可以透過 `slot="checked-icon"` 設定預設為 `check` 圖示，可傳入空字串移除預設圖示
`required`	`required`	`boolean`	`false`
送出表單時，是否必須選取此開關
`form`	`form`	`string`	-
關聯的 `<form>` 元素。此屬性值應為同一頁面中的一個 `<form>` 元素的 `id`。若未指定此屬性，則該元素必須是 `<form>` 元素的子元素。透過此屬性，你可以將元素放置在頁面的任何位置，而不僅僅是 `<form>` 元素的子元素。
`name`	`name`	`string`	`''`
開關的名稱，將與表單資料一起送出
`value`	`value`	`string`	`'on'`
開關的值，將與表單資料一起送出
	`validity`	`ValidityState`	-
表單驗證狀態物件，具體參見 `ValidityState`
	`validationMessage`	`string`	-
如果表單驗證未通過，此屬性將包含提示資訊。如果驗證通過，此屬性將為空字串
`autofocus`	`autofocus`	`boolean`	`false`
是否在頁面載入完成後自動取得焦點
`tabindex`	`tabIndex`	`number`	-
元素在使用 Tab 鍵切換焦點時的順序

方法

名稱	參數	回傳值
`checkValidity`		`boolean`
檢查表單欄位是否通過驗證。如果未通過，回傳 `false` 並觸發 `invalid` 事件；如果通過，回傳 `true`
`reportValidity`		`boolean`
檢查表單欄位是否通過驗證。如果未通過，回傳 `false` 並觸發 `invalid` 事件；如果通過，回傳 `true`。如果驗證未通過，還會在元件上顯示驗證失敗的提示。
`setCustomValidity`	`message: string`	`void`
設定自訂的錯誤提示文字。只要這個文字不為空，就表示欄位未通過驗證
`click`		`void`
模擬滑鼠點擊元素
`focus`	`options: FocusOptions` (選配)	`void`
將焦點設定到目前元素。可以傳入一個物件作為引數，該物件的屬性包括： `preventScroll`：預設情況下，元素取得焦點後，頁面會捲動以將該元素捲動到檢視中。如果不希望頁面捲動，可以將此屬性設定為 `true`。
`blur`		`void`
移除目前元素的焦點

事件

名稱
`focus`
取得焦點時觸發
`blur`
失去焦點時觸發
`change`
選取狀態變更時觸發
`input`
選取狀態變更時觸發
`invalid`
表單欄位驗證不通過時觸發

Slots

名稱
`unchecked-icon`
未選取狀態的元素
`checked-icon`
選取狀態的元素

CSS Parts

名稱
`track`
軌道
`thumb`
圖示容器
`unchecked-icon`
未選取狀態的圖示
`checked-icon`
選取狀態的圖示

CSS 自訂屬性

名稱
`--shape-corner`
元件軌道的圓角大小。可以指定一個具體的像素值；但更推薦引用設計令牌
`--shape-corner-thumb`
元件圖示容器的圓角大小。可以指定一個具體的像素值；但更推薦引用設計令牌

Snackbar 消息條

Tabs 分頁