Zum Inhalt springen
Dokumentation

Komponenten

Fehlerzustand (ErrorState)

Stabil

Erklärt einen fehlgeschlagenen Vorgang und bietet den erneuten Versuch an.

Ein Fehlerzustand erklärt, warum etwas nicht geklappt hat, und bietet den nächsten Schritt an: „Die Tickets konnten nicht geladen werden. Prüfe die Verbindung und versuche es erneut.“ Er ersetzt die fehlende Ansicht, statt sie leer zu lassen.

Wann verwenden

  • Wenn ein Laden oder eine Übertragung fehlgeschlagen ist und ein erneuter Versuch sinnvoll ist.
  • Wenn ein Datensatz nicht existiert, etwa nach einem veralteten Link oder einer umbenannten Station.
  • Wenn die Ansicht ohne diesen Inhalt nicht weitergeht und du eine Aktion anbieten willst.
  • Wenn die Ursache bekannt ist und in einem Satz erklärt werden kann.

Wann nicht

  • Für eine erwartbare Leere ohne Einträge ist ein Leerzustand (EmptyState) richtig; dort ist nichts schiefgelaufen.
  • Für ein einzelnes Feld gehört die Meldung an das Feld, nicht in den Seiteninhalt.
  • Für einen Hinweis, der zum restlichen Inhalt gehört, ist ein Hinweis (Alert) ruhiger.
  • Für einen Ausfall, der die ganze Ansicht betrifft, passt ein Banner (Banner) besser.

Erneut versuchen

Mit onRetry zeigt der Fehlerzustand eine Schaltfläche „Erneut versuchen“. Ohne onRetry bleibt nur der Text. Titel und Beschriftung kommen aus dem Sprachkatalog; im Beispiel lädt der zweite Versuch eine kurze Bestätigung.

Etwas ist schiefgelaufen

Die Tickets konnten nicht geladen werden. Prüfe die Verbindung und versuche es erneut.

Beispiel und Quelltext
laden.tsx
import * as React from "react";

import { Button, ErrorState } from "@neodin-eu/ui";

function Laden() {
  const [geladen, setGeladen] = React.useState(false);

  if (geladen) {
    return (
      <div className="flex w-full max-w-md flex-col items-center gap-3 rounded-xl border border-border bg-background p-6 text-center">
        <p className="text-sm font-semibold text-foreground">Tickets geladen</p>
        <p className="text-sm text-muted-foreground">
          Die Liste der offenen Tickets ist wieder verfügbar.
        </p>
        <Button variant="outline" size="sm" onClick={() => setGeladen(false)}>
          Fehler erneut zeigen
        </Button>
      </div>
    );
  }

  return (
    <div className="w-full max-w-md rounded-xl border border-border bg-background">
      <ErrorState
        description="Die Tickets konnten nicht geladen werden. Prüfe die Verbindung und versuche es erneut."
        onRetry={() => setGeladen(true)}
      />
    </div>
  );
}

Eigener Titel

Ohne title gilt „Etwas ist schiefgelaufen“ aus dem Katalog. Ein eigener Titel nennt die konkrete Lage, etwa „Station nicht gefunden“. Die Beschreibung sagt, was als Nächstes hilft.

Station nicht gefunden

Die Station wurde umbenannt oder geschlossen. Wähle eine andere Station im Filter.

Beispiel und Quelltext
nicht-gefunden.tsx
import { ErrorState } from "@neodin-eu/ui";

function NichtGefunden() {
  return (
    <div className="w-full max-w-md rounded-xl border border-border bg-background">
      <ErrorState
        title="Station nicht gefunden"
        description="Die Station wurde umbenannt oder geschlossen. Wähle eine andere Station im Filter."
      />
    </div>
  );
}

Barrierefreiheit

  • Ohne title zeigt der Fehlerzustand „Etwas ist schiefgelaufen“; bei einer anderen Sprache des NeodinProvider den passenden Text, etwa „Something went wrong“ für en-US. Beides ist im Komponententest abgesichert.
  • Nur mit onRetry erscheint die Schaltfläche „Erneut versuchen“. Der Test klickt sie und prüft, dass der Rückruf genau einmal läuft. Als native Schaltfläche folgt sie den Tastaturregeln des Browsers.
  • Das Symbol ist aria-hidden; Titel und Beschreibung sind Text. Der Fehlerzustand trägt keine Rolle alert und wird beim Einblenden nicht automatisch vorgelesen. Wenn die Meldung akut ist, gehört sie zusätzlich in einen Hinweis mit role="alert".
  • Der Fehlerzustand ist im Komponententest in hell und dunkel frei von axe-Verstößen, auch mit Beschreibung und Wiederholen-Schaltfläche.

Props

Props von ErrorState
PropTypStandardPflichtBeschreibung
actionReactNode–NeinExtra content below the retry button, such as a secondary action.
classNamestring–Nein–
descriptionReactNode–NeinExplanatory text below the title.
iconLucideIcon–NeinIcon shown above the title; defaults to an alert icon.
onRetry(() => void)–NeinShows a retry button that calls this handler.
retryLabelstring–NeinLabel of the retry button; defaults to the `retry` catalog entry.
titleReactNode–NeinError heading; defaults to the `errorTitle` catalog entry.

Siehe auch