Zum Hauptinhalt springen

Ihre Meinung ist uns wichtig! Gemeinsam mit Ihnen möchten wir KoliBri stetig verbessern. Teilen Sie uns Ihre Ideen, Wünsche oder Anregungen mit – schnell und unkompliziert.

Version

Diese Dokumentation wird aktuell überarbeitet und befindet sich im Beta-Status. Inhalte können sich noch ändern.

Synonyme: Versionsnummer, Releasebezeichnung

Beschreibung: Die Version-Komponente zeigt eine Versionsnummer oder Releasebezeichnung als kompaktes Inline-Element an. Sie ist optimal für die Darstellung von Versionsangaben an Seiten, Komponenten oder Funktionen geeignet und wird standardmäßig mit dem Präfix v ausgegeben.

Beispiel​

Darstellung der Komponente mit einer einfachen Versionsnummer:

<KolVersion _label="1.2.3" />

Barrierefreiheit​

Die Version-Komponente ist ein semantisches Inline-Element und wird von assistiven Technologien als solches erkannt:

  • Label-Beschriftung: Das über _label definierte Text wird von Screenreadern vorgelesen und vermittelt den Versionsstand.
  • Inline-Positionierung: Die Komponente ist ein Inline-Element und passt sich der Fließrichtung des Textes an.
  • Klare Kennzeichnung: Das automatisch vorangestellte v macht die Versionskennzeichnung eindeutig erkennbar.

Verwendung​

Best Practices / Empfehlungen​

  • Aussagekräftige Versionsnummern: Verwenden Sie standardisierte Versionsnummern (z.B. semantische Versionierung wie 1.2.3).
  • Kontextuelle Platzierung: Setzen Sie die Version an Stellen, wo Nutzer:innen schnell den aktuellen Stand erfassen müssen (z.B. im Header, in der Statusleiste).
  • Redundanz vermeiden: Zeigen Sie die Version nicht mehrfach hintereinander an.
  • Lesbarkeit: Die Komponente ist als Inline-Element konzipiert und passt sich dem bestehenden Zeilenfluss an.

Anwendungsfälle​

  • Anzeige der aktuellen Softwareversion im Header oder Footer
  • Markierung von Dokumentversionen oder Änderungsständen
  • Vergleich mehrerer Versionen nebeneinander
  • Indikator für Releasekanäle (z.B. 1.0.0-beta, 2.1.0-staging)

Konstruktion / Technik​

Playground​

<KolVersion _label="1.44.0" />

Funktionalitäten (mit Code)​

Basis-Versionsnummer​

Die sichtbare Versionsnummer wird über _label definiert. Das Präfix v wird automatisch hinzugefügt.

<KolVersion _label="2.0.0" />

API​

Properties​

PropertyAttributeDescriptionTypeDefault
_label (required)_labelDefines the visible or semantic label of the component (e.g. aria-label, label, headline, caption, summary, etc.).stringundefined