Skip to main content

Alert

Die Alert-Komponente gibt ein optisches Feedback an die Nutzer:innen. Sie besteht aus einem farblich gestalteten Container, einer Überschrift, einem Inhaltstext sowie einem Icon. Das verwendete Icon und die farbliche Gestaltung sind abhängig vom Typ _type des Alert.

Konstruktion

Code

<kol-alert _label="Überschrift im Alert" _level="1" _type="success">Textbereich im Alert</kol-alert>
<kol-alert _label="Überschrift im Alert" _level="2" _type="info" _variant="card">Textbereich im Alert</kol-alert>

Beispiel

Textbereich im Alert Textbereich im Alert

Verwendung

Überschrift

Die Überschrift der Alert-Komponente wird über das Attribut _label bestimmt.

Überschriftenebene

Die Überschriftenebene wird durch das Attribut _level übergeben. Möglich sind die Level 1 bis 6

Typ des Alert

Die Alert-Komponente bietet vier unterschiedliche Typen, die sich jeweils auf die farbliche Gestaltung und das verwendetet Icon im Alert beziehen. Zur Wahl stehen:

  • Success
  • Error
  • Info
  • Warning

Der Typ eines Alert wird über das Attribut _type festgelegt.

Inhalt des Alert

Der Inhalt des Alert wird zwischen das öffnende Element <kol-alert> und das schließende </kol-alert> geschrieben. Der Inhalt kann aus beliebigem HTML-Code, aber auch aus weiteren KoliBri-Komponenten bestehen.

Variante des Alert

Über das Attribut _variant kann festgelegt werden, in welcher Darstellungsvariante das Alert angezeigt wird. msg lässt die linke, farbig hinterlegte Spalte mit dem Icon über die gesamte Höhe des Alerts gehen, card setzt die linke Spalte nur neben die Überchrift.

Best practices

  • Verwenden Sie die Alert-Komponente an geeigneten Positionen auf Ihrer Webseite, um Informationen im richtigen Zusammenhang darzustellen.
  • Verwenden Sie immer den richtigen Type der Alert-Komponente, um bei den Benutzer:innen die gewünschte Reaktion zu erzeugen. Vermeiden Sie bspw. den Typ Error, wenn Sie auf den erfolgreichen Abschluss eines Speichervorgangs hinweisen möchten.
  • Vermeiden Sie, zu viele Alert-Komponenten auf einer Seite zu platzieren, da der Informationsgehalt von den Benutzer:innen dann oft nicht mehr als besonders wichtig wahrgenommen wird.

Anwendungsfälle

  • Verwenden Sie die Alert-Komponente, wenn Sie die Benutzer:innen auf Fehler bei der Eingabe in Formularen hinweisen möchten.
  • Verwenden Sie die Alert-Komponente, um Nutzer:innen auf die erfolgreiche Ausführung von Funktionen hinzuweisen, z.B. Ihre Anfrage wurde erfolgreich gespeichert.
  • Verwenden Sie die Alert-Komponente, um Nutzer:innen weitere Informationen zu einem Thema zur Verfügung zu stellen.

Barrierefreiheit

Die Alert-Komponente wurde auf die Darstellung mit höchstmöglichen Kontrast optimiert.

Das zusätzliche Icon (je nach gewähltem Typ) gewährleistet, dass die Information vom Nutzer nicht allein über die Farbe klassifiziert werden muss.

Bei der Alert-Komponente wurden insbesondere folgende Punkte der Barrierefreiheit betrachtet:

  • Die Schriftfarbe ist entweder weiß oder schwarz.
  • Die Schriftfarbe ist abhängig von der Hintergrundfarbe und wechselt immer auf die Schriftfarbe mit dem größeren Farbkontrast zur Hintergrundfarbe.
  • Ist der Farbkontrast für AA nicht ausreichend, wird die Hintergrundfarbe überschrieben.

Properties

PropertyAttributeDescriptionTypeDefault
_alert_alertDefines whether the screen-readers should read out the notification.boolean | undefinedfalse
_hasCloser_has-closerDefines whether the element can be closed.boolean | undefinedfalse
_label_labelDefines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.).string | undefinedundefined
_level_levelDefines which H-level from 1-6 the heading has. 0 specifies no heading and is shown as bold text.0 | 1 | 2 | 3 | 4 | 5 | 6 | undefined1
_on--Gibt die EventCallback-Function für das Schließen des Alerts an.undefined | { onClose?: EventCallback<Event> | undefined; }undefined
_type_typeDefines either the type of the component or of the components interactive element."default" | "error" | "info" | "success" | "warning" | undefined'default'
_variant_variantDefines which variant should be used for presentation."card" | "msg" | undefined'msg'

Slots

SlotDescription
Der Inhalt der Meldung.

Dependencies

Used by

Depends on

Graph


Live-Editor

Beispiele

Einfachs Meldungen

Card oder als Msg

Mit HTML-Struktur