Switch
Die Switch-Komponente schaltet den Ein-/Aus-Zustand einer einzelnen Option um. Durch die intuitive Interaktion lassen sich Einstellungen einfach anpassen.
Verwendung
Importieren Sie die Komponente nach Bedarf:
import 'mdui/components/switch.js';
Importieren Sie den TypeScript-Typ der Komponente nach Bedarf:
import type { Switch } from 'mdui/components/switch.js';
Beispiel:
<mdui-switch></mdui-switch>Beispiele
Ausgewählter Zustand
Wenn der Switch ausgewählt ist, hat das Attribut checked den Wert true. Sie können das Attribut checked auch hinzufügen, um den Switch standardmäßig ausgewählt zu haben.
Deaktivierter Zustand
Mit dem Attribut disabled wird die Switch-Komponente deaktiviert.
Symbol
Sie können über das Attribut unchecked-icon das Material Icons-Symbol für den nicht ausgewählten Zustand und über checked-icon das Symbol für den ausgewählten Zustand festlegen. Sie können dies auch über die Slots unchecked-icon und checked-icon tun.
API
Eigenschaften
| Attribut | Property | Reflect | Typ | Standard |
|---|---|---|---|---|
disabled | disabled | boolean | false | |
Deaktiviert den Switch. | ||||
checked | checked | boolean | false | |
Setzt den Switch in den aktivierten Zustand. | ||||
defaultChecked | boolean | false | ||
Der standardmäßig aktivierte Zustand. Der Switch setzt beim Zurücksetzen des Formulars auf diesen Zustand zurück. Nur JavaScript. | ||||
unchecked-icon | uncheckedIcon | string | - | |
Der Name des Material Icons für den nicht aktivierten Zustand. Alternativ können Sie | ||||
checked-icon | checkedIcon | string | - | |
Der Name des Material Icons für den aktivierten Zustand. Alternativ können Sie | ||||
required | required | boolean | false | |
Der Switch muss aktiviert sein, bevor das Formular gesendet wird. | ||||
form | form | string | - | |
Verknüpft den Switch mit einem Dies ermöglicht es dem Switch, mit jedem Formular im Dokument zu arbeiten, nicht nur mit dem, in dem er verschachtelt ist. | ||||
name | name | string | '' | |
Der Name des Switches, der mit Formulardaten übermittelt wird. | ||||
value | value | string | 'on' | |
Der Wert des Switches, der mit Formulardaten übermittelt wird. | ||||
validity | ValidityState | - | ||
Ein | ||||
validationMessage | string | - | ||
Validierungsnachricht. Leere Zeichenfolge, wenn gültig. | ||||
autofocus | autofocus | boolean | false | |
Gibt an, ob das Element beim Laden der Seite den Fokus erhält. | ||||
tabindex | tabIndex | number | - | |
Die Tab-Reihenfolge des Elements beim Navigieren mit der Tabulatortaste. | ||||
Methoden
| Name | Parameter | Rückgabewert |
|---|---|---|
checkValidity | boolean | |
Überprüft die Gültigkeit des Formularfelds. Wenn es ungültig ist, wird ein | ||
reportValidity | boolean | |
Überprüft die Gültigkeit des Formularfelds. Wenn es ungültig ist, wird ein | ||
setCustomValidity |
| void |
Setzt eine benutzerdefinierte Fehlermeldung. Wenn die Nachricht nicht leer ist, wird das Feld als ungültig betrachtet. | ||
click | void | |
Simuliert einen Mausklick auf das Element. | ||
focus |
| void |
Setzt den Fokus auf das Element. Der optionale Objektparameter kann eine | ||
blur | void | |
Entfernt den Fokus vom Element. | ||
Ereignisse
| Name |
|---|
focus |
Wird ausgelöst, wenn der Switch den Fokus erhält. |
blur |
Wird ausgelöst, wenn der Switch den Fokus verliert. |
change |
Wird ausgelöst, wenn sich der aktivierte Zustand ändert. |
input |
Wird ausgelöst, wenn sich der aktivierte Zustand ändert. |
invalid |
Wird ausgelöst, wenn die Gültigkeit des Formularsteuerelements überprüft wird und es die Einschränkungen nicht erfüllt. |
Slots
| Name |
|---|
unchecked-icon |
Element für den nicht aktivierten Zustand. |
checked-icon |
Element für den aktivierten Zustand. |
CSS Parts
| Name |
|---|
track |
Spur. |
thumb |
Daumen. |
unchecked-icon |
Icon für den nicht aktivierten Zustand. |
checked-icon |
Icon für den aktivierten Zustand. |
CSS Custom Property
| Name |
|---|
--shape-corner |
Der Eckradius der Spur. Sie können einen bestimmten Pixelwert verwenden, es wird jedoch empfohlen, auf Design-Tokens zu verweisen. |
--shape-corner-thumb |
Der Eckradius des Icon-Containers. Sie können einen bestimmten Pixelwert verwenden, es wird jedoch empfohlen, auf Design-Tokens zu verweisen. |