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

Definition

The TypeScript interface definition as found in the origam source. Click the copy icon to copy the snippet.

typescript

Inheritance

Extends

Parent interfaces this one inherits from. Their properties are available on every consumer of this interface.

API

Properties

Every property declared by this interface, with its type, optionality and default.

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".

Ecosystem

Used by

Components and composables that extend or consume this interface.

Usage

Examples

Ready-to-paste code snippets using this interface.

Single key

vue

Keyboard shortcut combination

vue