Abbr
Synonyme: Abkürzung, Kürzel
Beschreibung: Die Abbr-Komponente dient zur semantischen Kennzeichnung von Abkürzungen innerhalb von Texten.
Beispiel
Standard-Abkürzung mit optionalem Label:
<KolAbbr _label="zum Beispiel" >z. B.</KolAbbr>Barrierefreiheit
- Die Komponente kennzeichnet Abkürzungen semantisch.
- Die Bedeutung einer Abkürzung wird direkt im sichtbaren Text vermittelt.
- Die Komponente besitzt keine interaktiven Funktionen.
Konkrete desinentscheidungen
| Entscheidung | Begründung |
|---|---|
| Semantische Kennzeichnung von Abkürzungen | Unterstützt Browser und assistive Technologien bei der Interpretation von Inhalten. |
| Erläuterung der Bedeutung im sichtbaren Text | Alle Nutzenden erhalten dieselben Informationen unabhängig von Browser oder assistiven Technologien. |
| Keine Interaktion | Die Komponente dient ausschließlich der semantischen Auszeichnung von Text und benötigt daher keine Tastaturunterstützung. |
Links und Referenzen
Verwendung
Die Komponente eignet sich zur Kennzeichnung von Abkürzungen innerhalb von Fließtexten.
Best Practices / Empfehlungen
- Erläutern Sie die Bedeutung einer Abkürzung beim ersten Auftreten im sichtbaren Text, z. B. Barrierefreie-Informationstechnik-Verordnung (BITV) oder BITV (Barrierefreie-Informationstechnik-Verordnung).
- Anschließend kann die Abkürzung ohne erneute Erläuterung verwendet werden.
- Verwenden Sie die Komponente nur für Abkürzungen, deren Bedeutung für die Zielgruppe nicht selbstverständlich ist.
Anwendungsfälle
- Fachbegriffe
- Behördenabkürzungen
- Organisationen
- Technische Begriffe
- Gesetze und Richtlinien
Konstruktion / Technik
Playground
<KolAbbr _label="zum Beispiel" >z. B.</KolAbbr>Funktionalitäten (mit Code)
Abkürzung ohne Label
Abkürzung als reines Text-Element ohne zusätzliche Erklärung:
<KolAbbr _label="zum Beispiel" >z. B.</KolAbbr>Abkürzung mit Label
Abkürzung mit ausgeschriebener Erklärung über das _label-Attribut:
<KolAbbr _label="zum Beispiel" >z. B.</KolAbbr>API
Overview
The Abbr component implements the HTML tag abbr.
Properties
| Property | Attribute | Description | Type | Default |
|---|---|---|---|---|
_label | _label | DEPRECATED! Defines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.). | string | undefined | undefined |
Slots
| Slot | Description |
|---|---|
| The abbreviation (short form). |