Zum Inhalt springen
Dokumentation

Komponenten

Tastenkürzel (Kbd)

Stabil

Tasten und Kombinationen so darstellen, wie sie auf der Tastatur stehen.

Kbd zeigt eine einzelne Taste oder eine Kombination als kleines Feld im Fließtext – Strg + K, Esc, F5. Die Darstellung macht sichtbar, dass hier die Tastatur gemeint ist und nicht ein Wort im Satz.

Wann verwenden

  • In Hilfetexten und Kurzanleitungen, etwa „Suche öffnen mit Strg K“.
  • In Listen mit Tastenkürzeln für eine Ansicht, etwa Dienstplan oder Suche.
  • Wenn eine Taste Teil einer Anweisung ist und sich vom Text abheben soll.
  • Für Symboltasten wie Esc, Enter oder Tab genauso wie für Buchstaben.

Wann nicht

  • Für Schaltflächen. Ein Kürzel ist keine Aktion, sondern ein Hinweis darauf, wie die Aktion ohne Maus erreichbar ist.
  • Als Ersatz für eine Beschriftung. Steht nur ein Kürzel da, weiß niemand, was es auslöst.
  • Für Code oder Befehle im Terminal – dafür ist CodeBlock gedacht.
  • Gehäuft in jeder Zeile. Viele Felder nebeneinander werden unruhig; eine kurze Liste reicht.

Im Fließtext

Das Kürzel steht direkt in der Anweisung. Kbd ist inline und bricht nicht um; die Tasten einer Kombination stehen als eigene Felder nebeneinander.

Suche öffnen mit Strg K

Suche schließen mit Esc

Beispiel und Quelltext
befehlspalette.tsx
import { Kbd } from "@neodin-eu/ui";

function Befehlspalette() {
  return (
    <div className="w-full max-w-md rounded-md border border-border bg-background p-4">
      <p className="flex flex-wrap items-center gap-1.5 text-sm text-foreground">
        Suche öffnen mit <Kbd>Strg</Kbd> <Kbd>K</Kbd>
      </p>
      <p className="mt-3 flex flex-wrap items-center gap-1.5 text-sm text-muted-foreground">
        Suche schließen mit <Kbd>Esc</Kbd>
      </p>
    </div>
  );
}

Als Liste

Für eine Übersicht stehen Aktion und Kürzel in einer Zeile, das Kürzel rechts. So findet man beim Überfliegen die gesuchte Taste.

Dienstplan speichernStrgS
Nächste SchichtAlt→
Vorherige SchichtAlt←
Ansicht aktualisierenF5
Beispiel und Quelltext
kuerzel.tsx
import { Kbd } from "@neodin-eu/ui";

const KUERZEL = [
  { aktion: "Dienstplan speichern", tasten: ["Strg", "S"] },
  { aktion: "Nächste Schicht", tasten: ["Alt", "→"] },
  { aktion: "Vorherige Schicht", tasten: ["Alt", "←"] },
  { aktion: "Ansicht aktualisieren", tasten: ["F5"] },
];

function Kuerzel() {
  return (
    <div className="w-full max-w-md rounded-md border border-border bg-background px-4">
      {KUERZEL.map((eintrag) => (
        <div
          key={eintrag.aktion}
          className="flex items-center justify-between gap-4 border-b border-border py-2 last:border-b-0"
        >
          <span className="text-sm text-foreground">{eintrag.aktion}</span>
          <span className="flex items-center gap-1">
            {eintrag.tasten.map((taste) => (
              <Kbd key={taste}>{taste}</Kbd>
            ))}
          </span>
        </div>
      ))}
    </div>
  );
}

Barrierefreiheit

  • Kbd rendert ein natives kbd-Element. Es trägt keine eigene Rolle und keinen Tastaturfokus; der Text darin wird im Fluss der Zeile gelesen.
  • Der Komponententest prüft das Element, die Monospace-Darstellung und dass eine eigene className erhalten bleibt.
  • Symbole wie ⌘ oder → liest nicht jeder Screenreader gleich vor. Wo die Bedeutung wichtig ist, steht sie zusätzlich als Wort im Satz – im Beispiel „Suche öffnen mit“.
  • Kbd hat kein eigenes Tastaturverhalten: Es zeigt Kürzel an, es löst keine Aktion aus. Die Tastenkombination selbst gehört zur jeweiligen Komponente.
  • Im Komponententest ist das Kürzel im Fließtext in hell und dunkel frei von axe-Verstößen.

Props

Props von Kbd
PropTypStandardPflichtBeschreibung
classNamestring–Nein–

Siehe auch