# AlertBadge

Ein AlertBadge hebt Statusmeldungen hervor, die besondere Aufmerksamkeit erfordern.

```tsx
import { AlertBadge } from "@mittwald/flow-react-components";

<AlertBadge>Archiviert</AlertBadge>
```

---

# Best Practices

- Halte die Beschriftung kurz und prägnant, idealerweise auf ein bis drei
  Wörter.
- Wähle den Status passend zur Wichtigkeit der Meldung.
- Setze ein AlertBadge nur für kritische oder besonders aufmerksamkeitsstarke
  Hinweise ein. Für weniger dringende Fälle genügt ein
  [Badge](/04-components/status/badge).
- Lass auf ein AlertBadge weiterführende Informationen in einem
  [Alert](/04-components/status/alert) folgen.
- Orientiere dich am
  [Informationskonzept](/02-foundations/03-content-guidelines/02-informationskonzept).
  Es beschreibt das Zusammenspiel der Status-Komponenten.

## AlertBadge vs. Badge

  

- der Hinweis kritisch, sicherheitsrelevant oder besonders wichtig ist.
    - weitere Informationen durch einen Alert notwendig sind.

  

- Metadaten oder ergänzende Informationen dargestellt werden sollen.
    - keine sofortige Aktion oder erhöhte Aufmerksamkeit notwendig ist.

---

# Status

Je nach Anwendungsfall stehen verschiedene Status-Farben zur Auswahl:

- **Info** – Allgemeine Systemzustände oder laufende Prozesse, die keine Aktion
  erfordern.
- **Success** – Abgeschlossene, erfolgreiche oder positiv bewertete Zustände.
- **Warning** – Hinweise auf mögliche Risiken mit einer klaren
  Handlungsempfehlung.
- **Danger** – Akute Fehlerzustände oder kritische Probleme, die sofortige
  Aufmerksamkeit erfordern.
- **Unavailable** – Zustände aufgrund von nicht verfügbaren oder gelöschten
  Inhalten.

```tsx
import { AlertBadge } from "@mittwald/flow-react-components";

<>
  <AlertBadge status="info">Archiviert</AlertBadge>
  <AlertBadge status="success">
    Update erfolgreich
  </AlertBadge>
  <AlertBadge status="warning">
    Speicher fast voll
  </AlertBadge>
  <AlertBadge status="danger">Speicher voll</AlertBadge>
  <AlertBadge status="unavailable">
    Nicht gefunden
  </AlertBadge>
</>
```

---

# Properties

| Property | Type | Default | Description |
| --- | --- | --- | --- |
| `children` | `ReactNode` | - | - |
| `status` | `"info" \| "success" \| "warning" \| "danger" \| "unavailable"` | - | The elements status |
| `wrapWith` | `ReactElement<unknown, string \| JSXElementConstructor<any>>` | - | A React element the component is wrapped with. The element is cloned and receives the component as its only child — useful to render the component inside a link, a tooltip trigger or any other wrapper without changing the surrounding markup. |
| `ref` | `Ref<HTMLSpanElement>` | - | Allows getting a ref to the component instance. Once the component unmounts, React will set `ref.current` to `null` (or call the ref with `null` if you passed a callback ref). @see [React Docs](https://react.dev/learn/referencing-values-with-refs#refs-and-the-dom) |
| `key` | `Key` | - | - |
| `className` | `string` | - | The elements class name. |