Zum Hauptinhalt springen
Version: latest
Server-Komponente

Headline wird bevorzugt auf dem Server gerendert. Nutze den Standard-Import (z. B. @prokodo/ui/headline) — die Library erkennt die Umgebung automatisch.

Headline

Headline rendert eine typografische Überschrift (h1h6) mit angewendeter Design-Token-Typografie. Unterstützt visuelle Größen-Overrides, die die visuelle Darstellung von der semantischen Ebene entkoppeln.


Übersicht

import { Headline } from "@prokodo/ui/headline"
;<Headline level={1} size="h2" animated>
Willkommen bei prokodo UI
</Headline>

Import

import { Headline } from "@prokodo/ui/headline"

CSS:

import "@prokodo/ui/headline.css"

Props

PropTypStandardPflichtBeschreibung
childrenReactNodeÜberschriften-Inhalt.
type"h1" | "h2" | "h3" | "h4" | "h5" | "h6""h2"Gerendertes HTML-Überschriften-Tag.
size"xxl" | "xl" | "lg" | "md" | "sm" | "xs" | numberVisuelles Größen-Preset oder numerische Skala.
colorHeadlineVariantText-Farb-Variante.
weight"normal" | "bold" | "light"Schriftstärke-Override.
align"left" | "center" | "right"Textausrichtung.
highlightstringHervorgehobener Teilstring.
schemabooleanfalseJSON-LD-Schema-Markup ausgeben.
animationPropsAnimatedPropsEinblend-Animations-Konfiguration.
classNamestringCSS-Klasse am Root-Element.

Siehe src/components/headline/Headline.model.ts für den vollständigen HeadlineProps-Typ.


Design-Tokens

Headline definiert keine komponentenspezifischen CSS Custom Properties. Passe das Erscheinungsbild an, indem du folgende globale Design-System-Tokens auf :root oder einem übergeordneten Element überschreibst:

TokenBeschreibung
--pk-color-fgTextfarbe für color="inherit"
--pk-color-brandTextfarbe für color="primary"
--pk-color-accentTextfarbe für color="secondary"
--pk-color-mutedTextfarbe für color="info"
--pk-color-successTextfarbe für color="success"
--pk-color-warningTextfarbe für color="warning"
--pk-color-errorTextfarbe für color="error"
--pk-palette-whiteTextfarbe für color="white"
--pk-palette-blackTextfarbe für color="black"

WCAG-2.2-Status

KriteriumBezeichnungStatusHinweis
1.3.1Info und Beziehungen (A)✅ ErfülltSemantische Struktur (Überschriften, Listen, Labels, Landmarks) muss programmatisch via HTML oder ARIA vermittelt werden.
1.3.2Bedeutungsvolle Reihenfolge (A)🔍 Manuell prüfenDie Lesereihenfolge im DOM muss der beabsichtigten visuellen Darstellungsreihenfolge entsprechen.
1.4.3Kontrast (Minimum) (AA)🔍 Manuell prüfenText benötigt ein Kontrastverhältnis von mindestens 4,5:1 (3:1 für großen Text). Prüfung im finalen Produkt-Theme erforderlich.
2.4.6Überschriften und Bezeichnungen (AA)🔍 Manuell prüfenÜberschriften und Labels müssen das Thema oder den Zweck des zugehörigen Inhalts beschreiben.
4.1.2Name, Rolle, Wert (A)✅ ErfülltName, Rolle und Zustand aller interaktiven UI-Komponenten müssen via nativer HTML-Semantik oder ARIA programmatisch bestimmbar sein.

Testabdeckung: 3 jest-axe-Assertion(s) in 1 Testdatei(en) · 1 ARIA-Attribut-Vorkommen im Quellcode-Scan. Kriterien mit 🔍 erfordern manuelle Prüfung im finalen Integrations- und Theme-Kontext.

Storybook

👉 Headline in Storybook öffnen


Quellcode

src/components/headline/Headline.model.ts