IKbdProps

interface
Data Display

Props for <OrigamKbd> — renders keyboard shortcuts as styled <kbd> elements. Supports single key labels, composed shortcut combinations, and visual variants.

TypeScript

Définition

La définition TypeScript de l'interface telle que trouvée dans le code source d'origam. Cliquez sur l'icône de copie pour copier l'extrait.

typescript

Héritage

Hérite de

Interfaces parentes dont celle-ci hérite. Leurs propriétés sont disponibles pour tout consommateur de cette interface.

API

Propriétés

Chaque propriété déclarée par cette interface, avec son type, son caractère optionnel et sa valeur par défaut.

text
string
Single key label (e.g. "Ctrl", "A"). Overridden by the default slot.
combination
string[]
Composed shortcut rendered as individual nested <kbd> elements (e.g. ["Ctrl", "Shift", "Z"]).
separator
string
+
Character shown between each key in a combination. Defaults to "+".
variant
TKbdVariant
outlined
Visual variant controlling the look of the key badge. Defaults to "outlined".

Écosystème

Utilisé par

Composants et composables qui étendent ou consomment cette interface.

Usage

Exemples

Extraits de code prêts à coller utilisant cette interface.

Single key

vue

Keyboard shortcut combination

vue