Switch

Il componente Switch attiva o disattiva lo stato di una singola impostazione.

Utilizzo

Importa il componente:

import 'mdui/components/switch.js';

Importa il tipo TypeScript:

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

Esempio:

<mdui-switch></mdui-switch>

Usa gli attributi unchecked-icon e checked-icon per impostare le Icone Material rispettivamente per gli stati deselezionato e selezionato. Oppure, usa gli slot unchecked-icon e checked-icon per impostare le icone per gli stati deselezionato e selezionato.

<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>

Sorgente

API

Proprietà

Attributo HTML	Proprietà JavaScript	Tipo	Predefinito
`disabled`	`disabled`	`boolean`	`false`
Se il componente è disabilitato
`checked`	`checked`	`boolean`	`false`
Se il componente è selezionato
	`defaultChecked`	`boolean`	`false`
Stato selezionato predefinito. Quando si reimposta il modulo, verrà ripristinato a questo stato. Questa proprietà può essere impostata solo tramite JavaScript.
`unchecked-icon`	`uncheckedIcon`	`string`	-
Nome dell'icona Material per lo stato non selezionato. Può anche essere impostato tramite `slot="unchecked-icon"`.
`checked-icon`	`checkedIcon`	`string`	-
Nome dell'icona Material per lo stato selezionato. Può anche essere impostato tramite `slot="checked-icon"`. L'icona predefinita è `check`, è possibile passare una stringa vuota per rimuovere l'icona predefinita.
`required`	`required`	`boolean`	`false`
Se è obbligatorio selezionare questo interruttore al momento dell'invio del modulo
`form`	`form`	`string`	-
Elemento `<form>` associato. Il valore di questo attributo deve essere l'`id` di un elemento `<form>` nella stessa pagina. Se questo attributo non è specificato, l'elemento deve essere un elemento figlio dell'elemento `<form>`. Con questo attributo, puoi posizionare l'elemento in qualsiasi punto della pagina, non solo come figlio dell'elemento `<form>`.
`name`	`name`	`string`	`''`
Nome dell'interruttore, verrà inviato insieme ai dati del modulo
`value`	`value`	`string`	`'on'`
Valore dell'interruttore, verrà inviato insieme ai dati del modulo
	`validity`	`ValidityState`	-
Oggetto dello stato di convalida del modulo, per i dettagli fare riferimento a `ValidityState`
	`validationMessage`	`string`	-
Se la convalida del modulo non viene superata, questo attributo conterrà un messaggio informativo. Se la convalida viene superata, questo attributo sarà una stringa vuota
`autofocus`	`autofocus`	`boolean`	`false`
Se deve ricevere automaticamente il focus al caricamento della pagina
`tabindex`	`tabIndex`	`number`	-
Ordine di tabulazione dell'elemento

Metodi

Nome	Parametri	Restituisce
`checkValidity`		`boolean`
Verifica se il campo del modulo supera la convalida. In caso contrario, restituisce `false` e attiva l'evento `invalid`; in caso affermativo, restituisce `true`
`reportValidity`		`boolean`
Verifica se il campo del modulo supera la convalida. In caso contrario, restituisce `false` e attiva l'evento `invalid`; in caso affermativo, restituisce `true`. Se la convalida non viene superata, viene visualizzato un messaggio di errore sul componente.
`setCustomValidity`	`message: string`	`void`
Imposta un messaggio di errore personalizzato. Finché questo testo non è vuoto, significa che il campo non ha superato la convalida
`click`		`void`
Simula un clic del mouse sull'elemento
`focus`	`options: FocusOptions` (Opzionale)	`void`
Imposta il focus sull'elemento corrente. È possibile passare un oggetto come parametro, le cui proprietà includono: `preventScroll`: per impostazione predefinita, dopo che l'elemento riceve il focus, la pagina scorrerà per portare l'elemento in vista. Se non si desidera che la pagina scorra, è possibile impostare questa proprietà su `true`.
`blur`		`void`
Rimuove il focus dall'elemento corrente

Eventi

Nome
`focus`
Attivato quando si riceve il focus
`blur`
Attivato quando si perde il focus
`change`
Attivato quando lo stato di selezione cambia
`input`
Attivato quando lo stato di selezione cambia
`invalid`
Attivato quando la convalida del campo del modulo non viene superata

Slots

Nome
`unchecked-icon`
Elemento nello stato non selezionato
`checked-icon`
Elemento nello stato selezionato

CSS Parts

Nome
`track`
Traccia
`thumb`
Contenitore dell'icona
`unchecked-icon`
Icona nello stato non selezionato
`checked-icon`
Icona nello stato selezionato

CSS Custom Property

Nome
`--shape-corner`
Dimensione dell'arrotondamento degli angoli della traccia del componente. È possibile specificare un valore in pixel, ma si consiglia di fare riferimento al Design Token.
`--shape-corner-thumb`
Dimensione dell'arrotondamento degli angoli del contenitore dell'icona del componente. È possibile specificare un valore in pixel, ma si consiglia di fare riferimento al Design Token.

Capitolo precedente

Snackbar

Capitolo successivo

Tabs

Switch

Utilizzo

Esempi

Stato Selezionato

Stato Disabilitato

Icone