Ballmac UI home

Shortcut Hint

A compact accessible keycap sequence paired with the action it performs.

5/5 checksv1.0.0Updated Sep 30, 2026
What changed

Installation

$ pnpm dlx shadcn@latest add @ballmac/shortcut-hint

Usage

import { ShortcutHint } from "@/components/ballmac/shortcut-hint"

The full example is in the Code tab above.

Examples

States and variants

API reference

PropTypeDefault
keys*

Keys in order, such as ["⌘", "K"].

string[]—
label*

Action explained by the shortcut.

string—
compact

Render compact keycaps for dense menus.

booleanfalse

Also accepts the standard attributes of its root element.

Accessibility

KeyAction
NoneFull shortcut meaning is in the accessible name

Quality scorecard

5/5

Every applicable check passes

Measured in Chromium 153.0.8010.12 on October 19, 2026, on version 1.0.0, across 2 examples.

How we measure
  • Passed: Accessibility scan

    No serious or critical issues in light and dark, on a phone and a desktop (axe-core 4.13.0, WCAG 2.1 AA and best-practice rules).

  • Passed: Small screens

    No sideways scrolling at 360, 390 or 1280 px wide.

  • Passed: Reduced motion

    No endless animation to begin with.

  • Passed: Right to left

    Mirrors correctly in Arabic, Hebrew, Persian and Urdu layouts (0% of elements off the mirror, limit 15%).

  • Passed: Clean console

    No console errors or React hydration errors while loading.

  • Not applicable: Keyboard

    Static content: nothing to focus.

  • Not applicable: Loading, empty and error

    Does not show data or take submissions.

  • For information: Automated tests

    No test file of its own yet.

  • For information: Footprint

    0.8 KB of source (gzip) in 1 file. No extra npm packages.

Automated checks find a subset of problems and do not replace testing with a screen reader and a keyboard in your own app. What they miss.

Use with AI

A compact accessible keycap sequence paired with the action it performs. With the shadcn MCP server set up (guide), ask your agent:

Add the Ballmac UI Shortcut Hint (@ballmac/shortcut-hint) to this project with the shadcn MCP, then use it where it fits.

Use it for

  • Label a command in a menu
  • Teach an optional keyboard shortcut

Not for

  • Use kbd for an isolated key

Registry JSON: https://ui.ballmac.com/r/shortcut-hint.json

Credits

Free to use in personal and commercial projects.

npm
None

Ballmac UI Pro

Need the whole screen, not one piece?

311 premium blocks (dashboards, settings, calendars, mail, shops, onboarding), a private shadcn registry and Figma tokens. Blocks that show data come with loading, empty and error states built in.

Not ready? Try three Pro blocks free

Leave your email and the blocks appear right here, ready to copy. Yours to use in any project.