Select
Die Select-Komponente zeigt Optionen in einem Dropdown-Menü an und erleichtert so die Auswahl für Nutzer.
Diese Seite beschreibt hauptsächlich die Verwendung der <mdui-select>-Komponente. Informationen zur Verwendung von Menüpunkten finden Sie unter <mdui-menu-item>.
Verwendung
Importieren Sie die Komponenten nach Bedarf:
import 'mdui/components/select.js';
import 'mdui/components/menu-item.js';
Importieren Sie die TypeScript-Typen der Komponenten nach Bedarf:
import type { Select } from 'mdui/components/select.js';
import type { MenuItem } from 'mdui/components/menu-item.js';
Beispiel:
<mdui-select value="item-1">
<mdui-menu-item value="item-1">Item 1</mdui-menu-item>
<mdui-menu-item value="item-2">Item 2</mdui-menu-item>
</mdui-select>Mehrfachauswahl unterstützen
Das Select-Element ist standardmäßig auf Einfachauswahl eingestellt. Der value-Wert der <mdui-select>-Komponente ist der value-Wert des aktuell ausgewählten <mdui-menu-item>.
Fügen Sie das Attribut multiple hinzu, um die Mehrfachauswahl zu aktivieren. In diesem Fall ist der value-Wert von <mdui-select> ein Array der value-Werte der aktuell ausgewählten <mdui-menu-item>.
Hinweis: Bei aktivierter Mehrfachauswahl ist der value-Wert von <mdui-select> ein Array, das nur über eine JavaScript-Property gelesen und gesetzt werden kann.
Hilfstext
Mit dem Attribut label legen Sie den Label-Text über dem Select-Element fest.
Mit dem Attribut placeholder legen Sie den Platzhaltertext für nicht ausgewählte Werte fest.
Mit dem Attribut helper legen Sie den Hilfetext unter dem Select-Element fest. Sie können den Hilfetext auch über den Slot helper festlegen.
Nur-Lese-Modus
Fügen Sie das Attribut readonly hinzu, um das Select-Element in den Nur-Lese-Modus zu versetzen.
Deaktivierter Zustand
Fügen Sie das Attribut disabled hinzu, um das Select-Element zu deaktivieren.
Löschbar
Wenn Sie das Attribut clearable hinzufügen, erscheint rechts neben dem Select-Element eine Schaltfläche zum Löschen, wenn ein Wert ausgewählt ist.
Sie können die Schaltfläche zum Löschen auch über den Slot clear anpassen.
Position des Dropdown-Menüs
Über das Attribut placement können Sie die Position des Dropdown-Menüs festlegen.
Text rechtsbündig ausrichten
Fügen Sie das Attribut end-aligned hinzu, um den Text rechtsbündig auszurichten.
Text und Symbole links/rechts
Über die Attribute icon und end-icon können Sie links bzw. rechts vom Select-Element ein Material Icons-Symbol hinzufügen. Sie können auch über die Slots icon und end-icon Elemente hinzufügen.
Über die Attribute prefix und suffix können Sie links bzw. rechts vom Select-Element Text hinzufügen. Sie können auch über die Slots prefix und suffix Textelemente hinzufügen. Diese Texte werden nur angezeigt, wenn das Select-Element fokussiert ist oder einen Wert hat.
API
Eigenschaften
| Attribut | Property | Reflect | Typ | Standard |
|---|---|---|---|---|
variant | variant | 'filled' | 'outlined' | 'filled' | |
Definiert die Select-Variante. Mögliche Werte:
| ||||
multiple | multiple | boolean | false | |
Aktiviert Mehrfachauswahl. | ||||
name | name | string | '' | |
Name der Select-Komponente, der mit Formulardaten übermittelt wird. | ||||
value | value | string | string[] | '' | |
Wert der Select-Komponente, der mit Formulardaten übermittelt wird. Wenn | ||||
defaultValue | string | string[] | '' | ||
Standardmäßig ausgewählter Wert. Die Select-Komponente setzt beim Zurücksetzen des Formulars auf diesen Wert zurück. Nur JavaScript. | ||||
label | label | string | - | |
Beschriftungstext. | ||||
placeholder | placeholder | string | - | |
Platzhaltertext. | ||||
helper | helper | string | - | |
Hilfetext unter der Select-Komponente. Alternativ können Sie | ||||
clearable | clearable | boolean | false | |
Macht die Select-Komponente löschbar. | ||||
clear-icon | clearIcon | string | - | |
Name des Material Icons für den Löschen-Button rechts, wenn das Feld löschbar ist. Alternativ können Sie | ||||
placement | placement | 'auto' | 'bottom' | 'top' | 'auto' | |
Position der Select-Komponente. Mögliche Werte:
| ||||
end-aligned | endAligned | boolean | false | |
Richtet den Text rechtsbündig aus. | ||||
prefix | prefix | string | - | |
Präfix-Text der Select-Komponente. Er wird nur angezeigt, wenn die Select-Komponente fokussiert ist oder einen Wert hat. Alternativ können Sie | ||||
suffix | suffix | string | - | |
Suffix-Text der Select-Komponente. Er wird nur angezeigt, wenn die Select-Komponente fokussiert ist oder einen Wert hat. Alternativ können Sie | ||||
icon | icon | string | - | |
Name des Material Icons für das Präfix-Icon. Alternativ können Sie | ||||
end-icon | endIcon | string | - | |
Name des Material Icons für das Suffix-Icon. Alternativ können Sie | ||||
error-icon | errorIcon | string | - | |
Name des Material Icons, das bei fehlgeschlagener Formularfeldvalidierung rechts angezeigt wird. Alternativ können Sie | ||||
form | form | string | - | |
Verknüpft die Select-Komponente mit einem Dies ermöglicht es der Select-Komponente, mit jedem Formular im Dokument zu arbeiten, nicht nur mit dem, in dem sie verschachtelt ist. | ||||
readonly | readonly | boolean | false | |
Macht die Select-Komponente schreibgeschützt. | ||||
disabled | disabled | boolean | false | |
Deaktiviert die Select-Komponente. | ||||
required | required | boolean | false | |
Erfordert eine Auswahl, wenn das Formular gesendet 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 die Select-Komponente den Fokus erhält. |
blur |
Wird ausgelöst, wenn die Select-Komponente den Fokus verliert. |
change |
Wird ausgelöst, wenn sich der ausgewählte Wert ändert. |
invalid |
Wird ausgelöst, wenn die Gültigkeit des Formularsteuerelements überprüft wird und es die Einschränkungen nicht erfüllt. |
clear |
Wird ausgelöst, wenn der Löschen-Button angeklickt wird. Kann mit |
Slots
| Name |
|---|
| Standard |
|
icon |
Linkes Icon. |
end-icon |
Rechtes Icon. |
error-icon |
Rechtes Icon bei Validierungsfehler. |
prefix |
Linker Text. |
suffix |
Rechter Text. |
clear-button |
Löschen-Button. |
clear-icon |
Icon im Löschen-Button. |
helper |
Hilfetext unten. |
CSS Parts
| Name |
|---|
chips |
Container für Options-Chips, wenn |
chip |
Einzelner Chip, der eine Mehrfachauswahl-Option darstellt. |
chip__button |
Das |
chip__label |
Textteil des Chips. |
chip__delete-icon |
Lösch-Icon innerhalb des Chips. |
text-field |
Textfeld, d.h. |
text-field__container |
Container für das Textfeld. |
text-field__icon |
Icon innerhalb des Textfelds. |
text-field__end-icon |
Rechtes Icon innerhalb des Textfelds. |
text-field__error-icon |
Icon, das bei Validierungsfehler im Textfeld angezeigt wird. |
text-field__prefix |
Text auf der linken Seite des Textfelds. |
text-field__suffix |
Text auf der rechten Seite des Textfelds. |
text-field__label |
Beschriftungstext, der über dem Textfeld angezeigt wird. |
text-field__input |
Das |
text-field__clear-button |
Löschen-Button innerhalb des Textfelds. |
text-field__clear-icon |
Icon im Löschen-Button des Textfelds. |
text-field__supporting |
Container für unterstützende Informationen am unteren Rand des Textfelds, einschließlich Hilfetext und Fehlermeldungen. |
text-field__helper |
Hilfetext, der am unteren Rand des Textfelds angezeigt wird. |
text-field__error |
Fehlermeldung, die am unteren Rand des Textfelds angezeigt wird. |
menu |
Dropdown-Menü, d.h. |