Zum Inhalt springen
Dokumentation

Komponenten

Beschreibungsliste (DescriptionList)

Stabil

Bezeichnung und Wert als Paar – für Ticketdetails, Stammdaten und Zusammenfassungen.

Eine Beschreibungsliste stellt Bezeichnung und Wert gegenüber: Status und Priorität eines Tickets, Leitung und Bettenzahl einer Station. Jedes Paar steht für sich, die Reihenfolge bleibt fest – anders als bei einer Tabelle gibt es keine Spalten, die sortiert werden.

Wann verwenden

  • Für Details eines einzelnen Datensatzes, etwa die Angaben zu einem Ticket.
  • Wenn die Werte unterschiedlich lang sind und trotzdem bündig stehen sollen.
  • Als Zusammenfassung vor einer Aktion: Was ist bekannt, bevor du etwas änderst?
  • Auf schmalen Bildschirmen, weil die Liste von selbst untereinander umbricht.

Wann nicht

  • Für viele gleichartige Datensätze mit mehreren Merkmalen ist eine Tabelle besser; dort lassen sich Spalten vergleichen.
  • Für eine einzelne Kennzahl mit Einordnung genügt eine Kennzahl.
  • Für längliche Fließtexte sind Abschnitte mit Überschriften lesbarer; eine Definitionsliste ist für kurze Werte gedacht.

Aufbau

DescriptionList ist die Liste, DescriptionTerm die Bezeichnung und DescriptionDetails der Wert. Jedes Paar gehört direkt hintereinander. layout="stacked" setzt die Bezeichnung über den Wert, layout="inline" stellt beide ab der Größe sm in zwei Spalten nebeneinander.

Status
Offen
Priorität
Hoch
Station
Station 3
Zugewiesen an
Team Frühdienst
Gemeldet am
18.11.2026, 07:45 Uhr
Beispiel und Quelltext
ticket.tsx
import { DescriptionDetails, DescriptionList, DescriptionTerm } from "@neodin-eu/ui";

function Ticket() {
  return (
    <DescriptionList layout="inline" aria-label="Ticket T-1042" className="w-full max-w-xl">
      <DescriptionTerm>Status</DescriptionTerm>
      <DescriptionDetails>Offen</DescriptionDetails>
      <DescriptionTerm>Priorität</DescriptionTerm>
      <DescriptionDetails>Hoch</DescriptionDetails>
      <DescriptionTerm>Station</DescriptionTerm>
      <DescriptionDetails>Station 3</DescriptionDetails>
      <DescriptionTerm>Zugewiesen an</DescriptionTerm>
      <DescriptionDetails>Team Frühdienst</DescriptionDetails>
      <DescriptionTerm>Gemeldet am</DescriptionTerm>
      <DescriptionDetails>18.11.2026, 07:45 Uhr</DescriptionDetails>
    </DescriptionList>
  );
}

Gestapelt und zweispaltig

Die gestapelte Form passt in schmale Bereiche wie eine Seitenleiste oder eine Karte. Die zweispaltige Form eignet sich für Detailseiten, auf denen viele Werte untereinander stehen und die Bezeichnungen bündig sein sollen.

Station
Station 3 – Innere Medizin
Leitung
Teamleitung Frühdienst
Betten
24 Betten auf 12 Zimmern
Übergabe
Täglich um 06:45 und 14:45 Uhr
Beispiel und Quelltext
station.tsx
import { DescriptionDetails, DescriptionList, DescriptionTerm } from "@neodin-eu/ui";

function Station() {
  return (
    <DescriptionList aria-label="Stammdaten Station 3" className="w-full max-w-sm">
      <DescriptionTerm>Station</DescriptionTerm>
      <DescriptionDetails>Station 3 – Innere Medizin</DescriptionDetails>
      <DescriptionTerm>Leitung</DescriptionTerm>
      <DescriptionDetails>Teamleitung Frühdienst</DescriptionDetails>
      <DescriptionTerm>Betten</DescriptionTerm>
      <DescriptionDetails>24 Betten auf 12 Zimmern</DescriptionDetails>
      <DescriptionTerm>Übergabe</DescriptionTerm>
      <DescriptionDetails>Täglich um 06:45 und 14:45 Uhr</DescriptionDetails>
    </DescriptionList>
  );
}

Barrierefreiheit

  • Die Liste rendert die nativen Elemente dl, dt und dd. Im Komponententest wird geprüft, dass die Bezeichnung ein dt und der Wert ein dd ist.
  • Ein aria-label benennt die Liste, etwa „Ticket T-1042“. Damit lässt sie sich von anderen Listen auf der Seite unterscheiden.
  • Beide Layouts unterscheiden sich nur im Aussehen, nicht in der Reihenfolge der Elemente. Im Test werden data-layout und die Spaltenklasse geprüft.
  • Die Liste ist im Komponententest in hell und dunkel frei von axe-Verstößen.

Props

Props von DescriptionList
PropTypStandardPflichtBeschreibung
classNamestring–Nein–
layoutenumstackedNein`stacked` puts term above details, `inline` pairs them in two columns from `sm`.

DescriptionTerm und DescriptionDetails nehmen die Attribute ihres nativen Elements entgegen; zusätzlich lässt sich jeweils className setzen.

Siehe auch