Zum Inhalt springen
Dokumentation

Komponenten

Hinweis (Alert)

Stabil

Eine Meldung im Seitenfluss – Information, Erfolg, Warnung oder Fehler.

Ein Hinweis hebt eine Meldung im Seitenfluss hervor: der neue Dienstplan ist da, die Übergabe ist abgeschlossen, die Belegung ist hoch. Der Hinweis bleibt stehen, bis sich die Lage ändert – anders als eine kurze Einblendung.

Wann verwenden

  • Für eine Information, die zum aktuellen Inhalt gehört, etwa „Der Plan für Dezember ist ab Montag einsehbar“.
  • Für Rückmeldungen nach einer Aktion: Erfolg, Warnung oder Fehler.
  • Wenn die Meldung aus einem Titel und einem erklärenden Satz besteht.
  • Wenn ein nächster Schritt angeboten wird, etwa „Offene Dienste ansehen“.

Wann nicht

  • Für eine Meldung über die ganze Seite oder den ganzen Bereich nimm ein Banner; es sitzt am Rand und lässt sich schließen.
  • Für eine kurze Bestätigung nach dem Speichern genügt eine Einblendung (toast).
  • Für Feldvalidierung gehört der Text an das Feld, nicht in einen Hinweis.
  • Für dauerhafte Statusangaben, etwa „Offen“ oder „Bestätigt“, passt eine Kennzeichnung (Badge).

Varianten

variant bestimmt Ton und Symbol: info für neutrale Hinweise, success für abgeschlossene Vorgänge, warning für Aufmerksamkeit und danger für Fehler. AlertTitle und AlertDescription bilden den Inhalt.

Neuer Dienstplan
Der Plan für Dezember ist ab Montag einsehbar.
Übergabe abgeschlossen
Alle offenen Punkte der Schicht sind quittiert.
Bettenbelegung hoch
Station 2 ist zu 93 Prozent belegt.
Beispiel und Quelltext
varianten.tsx
import { Alert, AlertDescription, AlertTitle } from "@neodin-eu/ui";

function Varianten() {
  return (
    <div className="flex w-full max-w-xl flex-col gap-3">
      <Alert variant="info">
        <AlertTitle>Neuer Dienstplan</AlertTitle>
        <AlertDescription>Der Plan für Dezember ist ab Montag einsehbar.</AlertDescription>
      </Alert>
      <Alert variant="success">
        <AlertTitle>Übergabe abgeschlossen</AlertTitle>
        <AlertDescription>Alle offenen Punkte der Schicht sind quittiert.</AlertDescription>
      </Alert>
      <Alert variant="warning">
        <AlertTitle>Bettenbelegung hoch</AlertTitle>
        <AlertDescription>Station 2 ist zu 93 Prozent belegt.</AlertDescription>
      </Alert>
      <Alert variant="danger">
        <AlertTitle>Datenexport fehlgeschlagen</AlertTitle>
        <AlertDescription>
          Die Datei konnte nicht erstellt werden. Versuche es erneut.
        </AlertDescription>
      </Alert>
    </div>
  );
}

Mit Aktion

Eine Schaltfläche oder ein Link im Hinweis führt direkt zum nächsten Schritt. Sie steht unter dem Text, damit die Meldung zuerst gelesen wird.

Dienstplan noch nicht freigegeben

Zwei Dienste am Wochenende sind unbesetzt. Prüfe die offenen Einträge.

Beispiel und Quelltext
aktion.tsx
import { Alert, AlertDescription, AlertTitle, Button } from "@neodin-eu/ui";

function Aktion() {
  return (
    <Alert variant="warning" className="w-full max-w-xl">
      <AlertTitle>Dienstplan noch nicht freigegeben</AlertTitle>
      <AlertDescription>
        <p>Zwei Dienste am Wochenende sind unbesetzt. Prüfe die offenen Einträge.</p>
        <Button size="sm" variant="outline" className="mt-2">
          Offene Dienste ansehen
        </Button>
      </AlertDescription>
    </Alert>
  );
}

Baukasten

Wähle die Variante und ändere den Titel. Die Vorschau aktualisiert sich sofort, darunter steht der passende JSX-Code zum Kopieren.

Dienstplan veröffentlicht
Der Dienstplan ist ab 1. Dezember gültig.
Code
import { Alert } from "@neodin-eu/ui";

<Alert>Dienstplan veröffentlicht</Alert>

Barrierefreiheit

  • Die Variante bestimmt die Rolle: danger rendert role="alert", alle anderen Varianten role="status". Das ist im Komponententest für beide Rollen abgesichert.
  • Das Symbol ist aria-hidden; Titel und Text tragen die Aussage. Die Farbe ist damit nicht der einzige Hinweis.
  • Der Titel steht als eigener Text im Hinweis. Im Test werden Titel und Beschreibung unabhängig gefunden.
  • Der Hinweis ist im Komponententest in hell und dunkel frei von axe-Verstößen.

Props

Props von Alert
PropTypStandardPflichtBeschreibung
classNamestring–Nein–
iconLucideIcon–NeinOverrides the icon picked for the variant.
variant"info" | "success" | "warning" | "danger" | null–NeinVisual style and semantic colour of the alert; defaults to `"info"`.
Props von AlertTitle
PropTypStandardPflichtBeschreibung
classNamestring–Nein–
Props von AlertDescription
PropTypStandardPflichtBeschreibung
classNamestring–Nein–

Siehe auch