Skip to content

Commit df8af4e

Browse files
authored
enhance accordion docs (#271)
2 parents 3889ce4 + a3034fe commit df8af4e

File tree

1 file changed

+49
-9
lines changed

1 file changed

+49
-9
lines changed

docs/30-components/accordion.mdx

Lines changed: 49 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -87,28 +87,68 @@ Die Überschriftenebene wird durch das Attribut **`_level`** übergeben. Möglic
8787

8888
### Inhalt des Accordion
8989

90-
Der Hauptinhalt des Accordions wird über deb Slot übergeben.
90+
Der Hauptinhalt des Accordions wird über den Slot übergeben.
9191

9292
**`<kol-accordion _label="Element 1">Accordion-Inhalt</kol-accordion>`**
9393

9494
### Accordion geöffnet anzeigen
9595

9696
Standardmäßig wird das Accordion nach dem Laden der Seite im geschlossenen Zustand angezeigt. Soll das Accordion geöffnet angezeigt werden, setzen Sie das Attribut **\_open** zusätzlich ein.
9797

98+
### Vorteile
99+
100+
1. **Platzersparnis**: Ideal für Inhalte, die sonst viel Platz einnehmen würden.
101+
2. **Verbesserte Nutzererfahrung**: Nutzer:innen können Inhalte gezielt ein- und ausklappen.
102+
3. **Struktur und Übersicht**: Inhalte werden logisch gegliedert und wirken weniger überfordernd.
103+
98104
### Best practices
99105

100-
- Verwenden Sie ein Accordion, um lange Textabschnitte unter einem thematischen Oberbegriff zusammenzufassen
101-
- Verwenden Sie ein Accordion, um weniger wichtige Informationen, als Ergänzung zu Hauptinformationen, zur Verfügung zu stellen.
102-
- Mit einem Accordion können Sie die Länge Ihrer Webseite deutlich reduzieren und stellen gleichzeitig die Erreichbarkeit aller Informationen für die Nutzer:innen sicher.
103-
- Verwenden Sie eindeutige Überschriften, um die Nutzer:innen auf die weiteren Informationen des Accordions hinzuweisen.
104-
- Vermeiden Sie, wichtige `Call-To-Action`-Elemente innerhalb eines Accordions zu verbergen.
105-
- Lassen Sie Fehlermeldungen nicht innerhalb des Accordions anzeigen, um zu vermeiden, dass Nutzer:innen wichtige Informationen übersehen.
106-
- Verwenden Sie ein Accordion nicht als Auswahl-Element für Nutzer:innen.
107-
- Verwenden Sie ein Accordion nicht, um wichtige Informationen zu rechtlichen Angaben oder zum Datenschutz anzuzeigen.
106+
1. **Zweckmäßiger Einsatz**
107+
Verwenden Sie Accordions, um Inhalte unter einem thematischen Oberbegriff zu gruppieren, insbesondere bei langen Textabschnitten oder detaillierten Informationen.
108+
109+
2. **Unterstützende Informationen**
110+
Platzieren Sie in Accordions eher ergänzende oder weniger wichtige Informationen, die nicht unbedingt sofort sichtbar sein müssen.
111+
112+
3. **Reduktion der Seitenlänge**
113+
Nutzen Sie Accordions, um die visuelle Länge einer Webseite zu reduzieren, ohne die Zugänglichkeit von Inhalten einzuschränken.
114+
115+
4. **Eindeutige und beschreibende Überschriften**
116+
Verwenden Sie prägnante und aussagekräftige Überschriften, die den Inhalt des jeweiligen Abschnitts klar beschreiben, um die Orientierung zu erleichtern.
117+
118+
5. **Wichtige Aktionen und Inhalte sichtbar halten**
119+
Vermeiden Sie es, kritische `Call-to-Action`-Elemente oder zentrale Informationen innerhalb eines Accordions zu verstecken.
120+
121+
6. **Sichtbarkeit von Fehlermeldungen sicherstellen**
122+
Platzieren Sie Fehlermeldungen immer außerhalb eines Accordions um zu vermeiden, dass wichtige Informationen übersehen werden.
123+
124+
7. **Nicht als Auswahl-Element verwenden**
125+
Verwenden Sie Accordions nicht als interaktive Auswahl- oder Filterelemente, da sie für solche Interaktionen nicht intuitiv sind.
126+
127+
8. **Wichtige rechtliche Informationen außerhalb platzieren**
128+
Anzeigen wie Datenschutz- oder rechtliche Hinweise sollten nicht in Accordions versteckt werden, da diese stets leicht zugänglich und sichtbar sein müssen.
129+
130+
9. **Maximale Lesbarkeit**
131+
Halten Sie die Inhalte innerhalb eines Accordions kurz und übersichtlich. Verwenden Sie Listen, Absätze oder visuelle Trennungen, um eine Überforderung zu vermeiden.
132+
133+
10. **Standardmäßig wichtige Inhalte sichtbar machen**
134+
Überlegen Sie, ob es sinnvoll ist, einen oder mehrere Accordion-Abschnitte standardmäßig geöffnet zu lassen, insbesondere wenn diese Inhalte oft benötigt werden.
135+
136+
11. **Performance berücksichtigen**
137+
Stellen Sie sicher, dass das Accordion keine Ladezeitprobleme verursacht, insbesondere bei dynamisch geladenen Inhalten. Inhalte sollten möglichst asynchron und effizient geladen werden.
108138

109139
### Anwendungsfälle
110140

111141
- Häufig gestellte Fragen (FAQ)
142+
- Darstellung von Details, Eigenschaften oder Varianten eines Elements
143+
- Gruppierungen von
144+
- Formularen mit vielen Optionen
145+
- Daten in Dashboards
146+
- Filterfunktionen
147+
- Darstellung von Menüs auf kleinen Bildschirmen, bei denen Platz begrenzt ist
148+
- Gliederung in Einstellungsseiten
149+
- Aufteilung langer Artikel oder Dokumentationen in logische Abschnitte
150+
- Dynamisches Laden von Inhalten, welche nur bei Bedarf geladen werden
151+
- Darstellung eines Prozesses oder einer Anleitung, bei der einzelne Schritte ausgeklappt werden
112152

113153
## Barrierefreiheit
114154

0 commit comments

Comments
 (0)