MDUIDocs
llms.txt-Link kopierenllms-full.txt-Link kopierenDiese Seite als Markdown anzeigenDiese Seite mit ChatGPT besprechenDie gesamte Projektdokumentation mit ChatGPT besprechen
Voreingestellte Farbe
Benutzerdefinierte Farbe
Farbe aus Hintergrundbild extrahieren
Bitte wählen Sie ein Hintergrundbild aus
Erste Schritte
KI-gestützte Entwicklung
Stile
Integration mit Frameworks
Komponenten
Avatar Badge BottomAppBar Button ButtonIcon Card Checkbox Chip CircularProgress Collapse Dialog Divider Dropdown Fab Icon Layout LinearProgress List Menu NavigationBar NavigationDrawer NavigationRail Radio RangeSlider Select SegmentedButton Slider Snackbar Switch Tabs TextField Tooltip TopAppBar
Funktionen
Pakete

Checkbox

Checkboxen ermöglichen es Benutzern, eine oder mehrere Optionen aus einer Gruppe von Optionen auszuwählen oder den Ein-/Aus-Zustand einer einzelnen Option umzuschalten.

Verwendung

Importieren Sie die Komponente nach Bedarf:

import 'mdui/components/checkbox.js';

Importieren Sie den TypeScript-Typ der Komponente nach Bedarf:

import type { Checkbox } from 'mdui/components/checkbox.js';

Beispiel:

Checkbox
<mdui-checkbox>Checkbox</mdui-checkbox>

Beispiele

Ausgewählter Zustand

Wenn die Checkbox ausgewählt ist, hat das Attribut checked den Wert true. Fügen Sie das Attribut checked hinzu, um die Checkbox standardmäßig ausgewählt zu haben.

Deaktivierter Zustand

Mit dem Attribut disabled wird die Checkbox deaktiviert.

Unbestimmter Zustand

Mit dem Attribut indeterminate versetzen Sie die Checkbox in einen unbestimmten Zustand.

Symbol

Über die Attribute unchecked-icon, checked-icon und indeterminate-icon können Sie die Material Icons-Symbole für die Zustände nicht ausgewählt, ausgewählt und unbestimmt festlegen. Sie können dies auch über die Slots unchecked-icon, checked-icon und indeterminate-icon tun.

API

Eigenschaften

AttributPropertyReflectTypStandard
disableddisabledbooleanfalse

Deaktiviert die Checkbox.

checkedcheckedbooleanfalse

Setzt die Checkbox in den aktivierten Zustand.

defaultCheckedbooleanfalse

Setzt den standardmäßig aktivierten Zustand. Die Checkbox setzt beim Zurücksetzen des Formulars auf diesen Zustand zurück. Nur JavaScript.

indeterminateindeterminatebooleanfalse

Setzt die Checkbox in einen unbestimmten Zustand.

requiredrequiredbooleanfalse

Die Checkbox muss aktiviert sein, um das Formular zu senden.

formformstring-

Verknüpft die Checkbox mit einem <form>-Element. Setzen Sie dies auf die id eines <form>-Elements im selben Dokument. Wenn nicht angegeben, verwendet die Checkbox ihr übergeordnetes <form>-Element, falls vorhanden.

Dies ermöglicht es der Checkbox, mit jedem Formular im Dokument zu arbeiten, nicht nur mit dem, in dem sie verschachtelt ist.

namenamestring''

Setzt den Namen der Checkbox, der mit Formulardaten übermittelt wird.

valuevaluestring'on'

Setzt den Wert der Checkbox, der mit Formulardaten übermittelt wird.

unchecked-iconuncheckedIconstring-

Legt den Namen des Material Icons für den nicht aktivierten Zustand fest. Alternativ können Sie slot="unchecked-icon" verwenden.

checked-iconcheckedIconstring-

Legt den Namen des Material Icons für den aktivierten Zustand fest. Alternativ können Sie slot="checked-icon" verwenden.

indeterminate-iconindeterminateIconstring-

Legt den Namen des Material Icons für den unbestimmten Zustand fest. Alternativ können Sie slot="indeterminate-icon" verwenden.

validityValidityState-

Ein ValidityState-Objekt, das die Gültigkeitszustände des Elements darstellt.

validationMessagestring-

Validierungsnachricht. Leere Zeichenfolge, wenn gültig.

autofocusautofocusbooleanfalse

Gibt an, ob das Element beim Laden der Seite den Fokus erhält.

tabindextabIndexnumber-

Die Tab-Reihenfolge des Elements beim Navigieren mit der Tabulatortaste.

Methoden

NameParameterRückgabewert
checkValidity
boolean

Überprüft die Gültigkeit des Formularfelds. Wenn es ungültig ist, wird ein invalid-Ereignis ausgelöst und false zurückgegeben. Wenn gültig, wird true zurückgegeben.

reportValidity
boolean

Überprüft die Gültigkeit des Formularfelds. Wenn es ungültig ist, wird ein invalid-Ereignis ausgelöst, false zurückgegeben und eine Validierungsnachricht angezeigt. Wenn gültig, wird true zurückgegeben.

setCustomValidity
  • message: string
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
  • options: FocusOptions (Optional)
void

Setzt den Fokus auf das Element. Der optionale Objektparameter kann eine preventScroll-Eigenschaft enthalten. Wenn preventScroll auf true gesetzt ist, scrollt die Seite nicht, um das fokussierte Element in den sichtbaren Bereich zu bringen.

blur
void

Entfernt den Fokus vom Element.

Ereignisse

Name
focus

Wird ausgelöst, wenn die Checkbox den Fokus erhält.

blur

Wird ausgelöst, wenn die Checkbox 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
Standard

Text.

unchecked-icon

Icon für den nicht aktivierten Zustand.

checked-icon

Icon für den aktivierten Zustand.

indeterminate-icon

Icon für den unbestimmten Zustand.

CSS Parts

Name
control

Container für das linke Icon.

unchecked-icon

Icon für den nicht aktivierten Zustand.

checked-icon

Icon für den aktivierten Zustand.

indeterminate-icon

Icon für den unbestimmten Zustand.

label

Text.

Auf dieser Seite