Skip to content

Commit e176110

Browse files
docs: Add docs for Autocomplete (#1727)
* docs: autocomplete * update autocomplete vs. combobox guidelines.mdx * Changes after Review on guidelines.mdx * Changes after Review on overview.mdx * small fixes guidelines.mdx
1 parent 31bd772 commit e176110

File tree

3 files changed

+41
-3
lines changed

3 files changed

+41
-3
lines changed
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# Grundlagen
2+
3+
Autocomplete dient dazu, Usern beim Ausfüllen von Texteingabefeldern durch Vorschläge zu unterstützen. Während der Eingabe werden relevante Optionen angezeigt, aus denen ausgewählt werden kann. Die Auswahl eines Vorschlags ist optional, User können auch eigene Eingaben vornehmen. Autocomplete wird typischerweise in Kombination mit Komponenten wie [TextField](/03-components/form-controls/text-field) oder [SearchField](/03-components/form-controls/search-field) eingesetzt.
4+
5+
## Best practices
6+
Achte bei der Verwendung von Autocomplete darauf, dass…
7+
* die Vorschläge kontextbezogen sind.
8+
* die Vorschlagsliste bei Bedarf sinnvoll vorgefiltert werden kann (z. B. anhand von Kategorien oder Kontext).
9+
* bei leerem Eingabefeld zunächst keine Vorschläge angezeigt werden.
10+
11+
12+
## Verwendung
13+
Verwende ein Autocomplete, um…
14+
* die Effizienz bei der Dateneingabe zu verbessern, insbesondere bei bekannten oder häufig genutzten Optionen.
15+
* Tippfehler zu vermeiden und die Datenqualität zu erhöhen.
16+
* lange Auswahlmenüs zu vermeiden, indem Vorschläge dynamisch gefiltert werden.
17+
18+
## Autocomplete vs. ComboBox
19+
20+
Autocomplete und [ComboBoxen](/03-components/form-controls/combo-box) sehen oft ähnlich aus, erfüllen aber unterschiedliche Zwecke.
21+
<DoAndDont>
22+
<Plain heading="Verwende Autocomplete, um z. B. …">
23+
- Usern zu ermöglichen, freie Eingaben zu machen, während Vorschläge zur Auswahl angezeigt werden.
24+
- bei langen oder dynamischen Datenlisten (z. B. Städte, Usernamen, Tags).
25+
</Plain>
26+
27+
<Plain heading="Verwende ComboBox, um z. B. …">
28+
- aus einer vordefinierten Liste von Optionen eine Auswahl zu treffen.
29+
- bei bekannten, überschaubaren Optionen (z. B. Sprachen, Kategorien, Geschlecht).
30+
</Plain>
31+
</DoAndDont>
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
---
22
component: Autocomplete
33
description:
4-
Die Autocomplete-Komponente unterstützt Nutzer:innen beim ausfüllen von
5-
Eingabefeldern. Es werden passende Optionen während der Eingabe vorgeschlagen.
4+
Autocomplete unterstützt bei der Texteingabe durch kontextbezogene Vorschläge. Die Auswahl ist optional, eigene Eingaben bleiben möglich. Typischerweise wird die Komponente mit TextField oder SearchField kombiniert.
65
---
76

87
<LiveCodeEditor editorDisabled />
Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,29 @@
11
# Playground
22

3+
Lege `<Autocomplete />`, um ein [TextField](/03-components/form-controls/text-field) oder ein [SearchField](/03-components/form-controls/search-field), um Texteigaben mit Vorschlägen zu unterstützen.
4+
35
<LiveCodeEditor />
46

57
---
68

79
# Benutzerdefinierte Filter
810

9-
<LiveCodeEditor example="filter" />
11+
Schränke die Optionen, die dem User zur Auswahl stehen mithilfe von Filtern ein.
12+
13+
<LiveCodeEditor example="filter" editorCollapsed />
1014

1115
---
1216

1317
# Kombiniere mit ...
1418

1519
## SearchField
1620

21+
Nutze `<Autocomplete />` mit einem [SerachField](/03-components/form-controls/search-field), um die User beim Suchen mit Vorschlägen zu unterstützen.
22+
1723
<LiveCodeEditor example="search" editorCollapsed />
1824

1925
## React Hook Form
2026

27+
Weitere Details zur Formularlogik und -validierung sind in der Component [Form (React Hook Form)](/03-components/form-controls/form-react-hook-form) zu finden.
28+
2129
<LiveCodeEditor example="form" editorCollapsed />

0 commit comments

Comments
 (0)