Zum Inhalt springen
Dokumentation

Komponenten

Hinweisleiste (Banner)

Stabil

Eine Meldung über den ganzen Bereich – für Wartung, Ausfälle und wichtige Änderungen.

Ein Banner liegt über den ganzen Bereich und meldet etwas, das für alle gilt: ein Wartungsfenster, eine nicht erreichbare Schnittstelle, eine neue Version. Es lässt sich schließen, damit die Fläche wieder frei wird.

Wann verwenden

  • Für eine Meldung, die für die ganze Ansicht gilt, etwa eine geplante Wartung.
  • Für einen Ausfall, der die Arbeit gerade einschränkt.
  • Wenn die Meldung schließbar sein soll, sobald sie gelesen ist.
  • Wenn ein nächster Schritt wichtig ist, etwa ein Link zum Wartungsplan.

Wann nicht

  • Für eine Meldung, die zu einem Abschnitt gehört, ist ein Hinweis ruhiger; er bleibt im Fluss des Inhalts.
  • Für eine kurze Bestätigung nach einer Aktion genügt eine Einblendung (toast).
  • Für dauerhafte Hinweise, die nicht verschwinden dürfen, ist ein Banner mit Schließenknopf die falsche Form.

Aufbau

variant wählt Ton und Symbol wie beim Hinweis. title steht fett über dem Text, action nimmt einen Link oder eine Schaltfläche auf. onClose zeigt den Schließenknopf; nach einem Klick verschwindet das Banner und der Rückruf läuft.

Wartungsfenster am Sonntag

Die Anwendung ist von 22 bis 23 Uhr nicht erreichbar. Speichere deine Arbeit vorher.
Beispiel und Quelltext
wartung.tsx
import { Banner } from "@neodin-eu/ui";

function Wartung() {
  return (
    <Banner
      variant="warning"
      title="Wartungsfenster am Sonntag"
      onClose={() => {}}
      action={
        <a href="#wartung" className="text-sm underline underline-offset-4">
          Zum Wartungsplan
        </a>
      }
    >
      Die Anwendung ist von 22 bis 23 Uhr nicht erreichbar. Speichere deine Arbeit vorher.
    </Banner>
  );
}

Ohne Schließenknopf

Ohne onClose bleibt das Banner stehen. Das passt für Störungen, die noch andauern, und für Meldungen, die nicht weggeklickt werden sollen.

Beispiel und Quelltext
ausfall.tsx
import { Banner } from "@neodin-eu/ui";

function Ausfall() {
  return (
    <Banner variant="danger" title="Schnittstelle nicht erreichbar">
      Neue Tickets können gerade nicht übertragen werden. Bereits erfasste Einträge bleiben
      erhalten.
    </Banner>
  );
}

Barrierefreiheit

  • danger rendert role="alert", alle anderen Varianten role="status". Beides ist im Komponententest abgesichert.
  • Der Schließenknopf ist ein natives button-Element mit dem zugänglichen Namen „Schließen“ aus dem Katalog. Im Test wird er über diesen Namen gefunden und löst onClose genau einmal aus.
  • Ohne onClose gibt es keinen Schließenknopf; der Test prüft, dass er dann nicht im Baum steht.
  • Das Symbol ist aria-hidden; Titel und Text tragen die Aussage.
  • Das Banner ist im Komponententest in hell und dunkel frei von axe-Verstößen.

Props

Props von Banner
PropTypStandardPflichtBeschreibung
actionReactNode–NeinExtra content rendered below the banner body, such as a link or button.
classNamestring–Nein–
iconLucideIcon–NeinOverrides the icon picked for the variant.
onClose(() => void)–NeinShows a close button; called after the banner has been dismissed.
titleReactNode–NeinBold heading rendered above the banner body.
variantenum–NeinVisual style and semantic colour of the banner; defaults to `"info"`.

Siehe auch