Ballmac UI home

Keyboard ShortcutsPRO

A searchable shortcut cheat sheet, inline or in a dialog opened by pressing ?, with Command or Ctrl keys chosen for the viewer's platform and spoken key names.

General

  • Open command menuCtrl plus K
  • Show shortcuts?
  • Toggle sidebarCtrl plus B
  • SaveCtrl plus S

Navigation

  • Go to inboxG then I
  • Go to projectsG then P
  • Next itemJ
  • Previous itemK

Editing

  • BoldCtrl plus B
  • Move line upAlt plus Up arrow
  • Duplicate lineShift plus Alt plus Down arrow
  • UndoCtrl plus Z

Installation

  1. Get a Pro licence key.

    The source is part of Ballmac UI Pro.

    Log in with your licence key to read and copy it here, or install it through the shadcn CLI or the MCP server. You own the code once it is in your project.

    $49 once regular price $99for this and every other Pro item. Tax included.Money back if it does not work.

  2. Once per project: add the Pro registry and your licence key.

    components.json
    {
      "registries": {
        "@ballmac": "https://ui.ballmac.com/r/{name}.json",
        "@ballmac-pro": {
          "url": "https://ui.ballmac.com/r/pro/{name}.json",
          "headers": { "Authorization": "Bearer ${BALLMAC_LICENSE_KEY}" }
        }
      }
    }
    .env.local
    BALLMAC_LICENSE_KEY=your-licence-key
  3. Add it.

    $ pnpm dlx shadcn@latest add @ballmac-pro/keyboard-shortcuts

Usage

import { KeyboardShortcuts, KeyboardShortcutsDialog } from "@/components/ballmac/keyboard-shortcuts"

The full example is in the Code tab above.

Examples

Dialog opened with ?

API reference

<KeyboardShortcuts>

PropTypeDefault
groups*

Shortcuts, grouped.

ShortcutGroup[]—
searchable

Show a search box that filters by action or key.

booleantrue
platform

Which key labels to draw. "auto" picks Mac or other after hydration.

ShortcutPlatform | "auto"—
searchPlaceholder

Placeholder of the search box.

string—
columns

Number of columns on wide containers.

1 | 22

<KeyboardShortcutsDialog>

PropTypeDefault
open

Controlled open state.

boolean—
defaultOpen

Initial open state.

booleanfalse
onOpenChange

Called when the dialog opens or closes.

(open: boolean) => void—
hotkey

Key that opens the dialog from anywhere outside a text field. Set to `null` to turn it off.

string | null"?"
title

Dialog heading.

string—
description

Line under the heading.

string—
className

Classes for the dialog panel.

string—

Also accepts the standard attributes of its root element.

Accessibility

KeyAction
?Opens the dialog when focus is not in a text field
EscapeCloses the dialog
Screen readersKeys read as 'Command plus K', sequences as 'G then I'; the filtered count is announced

Quality scorecard

7/7

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 (13% of elements off the mirror, limit 15%).

  • Passed: Clean console

    No console errors or React hydration errors while loading.

  • Passed: Keyboard

    2 tab stops, each showing a visible change when it takes focus. 3 documented keys.

  • Not applicable: Loading, empty and error

    Does not show data or take submissions.

  • Passed: Automated tests

    Covered by keyboard-shortcuts.test.tsx.

  • For information: Footprint

    3.5 KB of source (gzip) in 1 file. Installs lucide-react.

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

groups is [{ title, shortcuts: [{ label, keys, sequence?, description? }] }]. Use 'Mod' for Cmd on Mac and Ctrl elsewhere. <KeyboardShortcutsDialog hotkey='?'> opens from anywhere outside a text field. platform='auto' corrects after hydration. With the shadcn MCP server set up (guide), ask your agent:

Add the Ballmac UI Keyboard Shortcuts (@ballmac-pro/keyboard-shortcuts) to this project with the shadcn MCP, then use it where it fits.

Use it for

  • A help overlay for apps with many shortcuts
  • Docs pages that list hotkeys

Not for

  • A single hint beside a button (shortcut-hint)
  • Binding the shortcuts themselves; this only displays them

Registry JSON (needs your licence key): https://ui.ballmac.com/r/pro/keyboard-shortcuts.json

Credits

Covered by the Ballmac UI Pro license.