Unkey
Components

KeyboardButton

A component for displaying keyboard shortcuts with optional modifier keys

KeyboardButton

The KeyboardButton component is designed to display keyboard shortcuts in a visually appealing and accessible way. It supports displaying both regular keys and modifier keys (like ⌘, ⇧, CTRL, ⌥) in a consistent format.

Features

  • Displays keyboard shortcuts with optional modifier keys
  • Accessible with proper ARIA attributes
  • Supports both light and dark themes
  • Responsive design with mobile considerations
  • Customizable through className prop

Props

PropTypeDescription
shortcutstringThe main key of the keyboard shortcut
modifierKey"⌘" | "⇧" | "CTRL" | "⌥" | nullOptional modifier key to be displayed before the main shortcut
classNamestringAdditional CSS classes to customize the component

The component also accepts all standard HTML div element props.

Usage

Default and Modifier Key

DefaultDModifier Key+K

Accessibility

The component includes:

  • Proper ARIA labels for screen readers
  • Keyboard focus management
  • Descriptive title attributes for tooltips

Design

The component features:

  • Consistent padding and sizing
  • Drop shadow effects
  • Hover and focus states
  • Dark mode support
  • Responsive behavior (hidden on mobile devices)

On this page