Skip to content

ShortcutOverlay

A dialog that lists the keyboard shortcuts of an app in groups, opened with the ? key. CommandPalette can offer it through shortcutOverlay.

  • ShortcutOverlay

PreviewLink to the section Preview

Live in all three themes. Everything here is interactive.

Light theme, ShortcutOverlay

Dark theme, ShortcutOverlay

High contrast theme, ShortcutOverlay

UsageLink to the section Usage

tsx
import { ShortcutOverlay } from '@skribly/ui/search'
tsx
<ShortcutOverlay isOpen={open} onOpenChange={setOpen} shortcut
  label="Keyboard shortcuts" closeLabel="Close" groups={[
    { id: 'general', label: 'General', shortcuts: [{ id: 'palette', label: 'Open the palette', keys: ['Ctrl', 'K'] }] }
  ]} />

Every label is a prop, so the app passes its own words in its own language. See no built-in text.

AccessibilityLink to the section Accessibility

  • A modal dialog named by its heading: focus stays inside while open and returns to the trigger on close, and Escape closes it.
  • The ? key opens it only when focus is not in a text field or an editable area.
  • Each group is a labelled region with a list of terms, and every key is a kbd element, so a screen reader reads the action first and then its keys.
  • On narrow screens it becomes a full-screen sheet.

This demo runs through axe in all three themes on every test run. See what the tests check.

Search this site

Arrows move through the results, Enter opens one, Esc closes. Ctrl K /