Class Table
Die Class Table dient zur Dokumentation von CSS-Klassen innerhalb von DK97 UI.
Sie stellt Klassen und deren Beschreibung in einer strukturierten Tabellenform dar.
Beispiele
Basic
Eine einfache Tabelle zur Dokumentation von Klassen.
| Klasse | Beschreibung |
|---|---|
.a-button |
Basis-Klasse für Buttons. |
.-primary |
Primary Variante. |
<table class="m-class-table">
<thead>
<tr>
<th>Klasse</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>.a-button</code></td>
<td>Basis-Klasse für Buttons.</td>
</tr>
<tr>
<td><code>.-primary</code></td>
<td>Primary Variante.</td>
</tr>
</tbody>
</table>
Extended
Eine Class Table kann beliebig viele Klassen und Modifier dokumentieren.
| Klasse | Beschreibung |
|---|---|
.a-badge |
Basis-Klasse für Badges. |
.-success |
Badge für positive Zustände. |
.-warning |
Badge für Warnungen. |
.-danger |
Badge für kritische Zustände. |
<table class="m-class-table">
<thead>
<tr>
<th>Klasse</th>
<th>Beschreibung</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>.a-badge</code></td>
<td>Basis-Klasse für Badges.</td>
</tr>
<tr>
<td><code>.-success</code></td>
<td>Badge für positive Zustände.</td>
</tr>
<tr>
<td><code>.-warning</code></td>
<td>Badge für Warnungen.</td>
</tr>
<tr>
<td><code>.-danger</code></td>
<td>Badge für kritische Zustände.</td>
</tr>
</tbody>
</table>
Klassen
| Klasse | Beschreibung |
|---|---|
.m-class-table |
Container der Klassentabelle. |
<thead> |
Kopfbereich der Tabelle. |
<tbody> |
Tabelleninhalt. |
Hinweise
Hinweis
Die Class Table wird hauptsächlich innerhalb der Dokumentation verwendet,
um verfügbare Klassen und Modifier einer Komponente zu beschreiben.
Best Practices
Empfohlene Verwendung
Dokumentiere jede öffentliche Klasse einer Komponente.
Dadurch bleibt die Verwendung nachvollziehbar und konsistent.
Vermeiden
Interne Hilfsklassen sollten normalerweise nicht dokumentiert werden.
Die Dokumentation sollte sich auf die öffentliche API der Komponente konzentrieren.
Accessibility
Accessibility
Tabellen sollten immer Tabellenüberschriften verwenden.
Dadurch können Screenreader die Inhalte korrekt zuordnen.