# Building a Keyboard Shortcut Cheat Sheet in Octane

A cheat sheet lists the shortcuts users can press. Build it from the same hotkeys that handle the key presses, and it stays correct when a hotkey changes. The helpers in this guide are optional, and each works on its own, so use only the ones your UI needs.

TanStack Hotkeys gives you two lists to build from:

- `useHotkeyRegistrations` returns the hotkeys registered right now, in its `hotkeys` array. It works with plain `useHotkey` and `useHotkeys`, but it only knows about mounted components.
- `useAppHotkeyList` returns every [app hotkey](./app-hotkeys) you declared, including hotkeys on pages that haven't rendered, with the status of each.

Start with registrations. Switch to app hotkeys when the cheat sheet should list shortcuts from the whole app, or when users can change them. Label each hotkey with `formatForDisplay`, covered in [Formatting & Display](./formatting-display).

## Name your hotkeys

A cheat sheet needs a name for each hotkey. Pass one in `meta`, with an optional description and group:

```tsx
useHotkeys([
  {
    hotkey: 'Mod+S',
    callback: () => save(),
    options: { meta: { name: 'Save', group: 'File' } },
  },
  {
    hotkey: 'Mod+Shift+S',
    callback: () => saveAs(),
    options: { meta: { name: 'Save as', group: 'File' } },
  },
  {
    hotkey: ['G', 'H'],
    callback: () => goHome(),
    options: { meta: { name: 'Go home', group: 'Navigation' } },
  },
])
```

`meta` doesn't change how a hotkey behaves. Devtools show it too.

`meta` is typed as `HotkeyMeta`. To add fields of your own, such as an icon, extend it with declaration merging:

```ts
declare module '@tanstack/hotkeys' {
  interface HotkeyMeta {
    icon?: string
  }
}
```

## List the hotkeys on screen

`useHotkeyRegistrations` returns every registered hotkey, and updates when hotkeys register, unregister, or change. Show the ones with a name:

```tsx
import { formatForDisplay, useHotkeyRegistrations } from '@tanstack/octane-hotkeys'

function ShortcutList() @{
  const registrations = useHotkeyRegistrations().hotkeys.filter(
    (reg) => reg.options.meta?.name && reg.options.enabled !== false,
  )

  <dl>
    @for (const reg of registrations; key reg.id) {
      <div>
        <dt>{reg.options.meta?.name}</dt>
        <dd>
          <kbd>{formatForDisplay(reg.hotkey)}</kbd>
        </dd>
      </div>
    }
  </dl>
}
```

Filtering by name leaves out hotkeys you didn't mean to list, such as a dialog's `Escape`. Filtering out disabled hotkeys leaves only the ones that work right now.

Each registration view has an `id`, the `hotkey`, its `options` (including `meta`, `enabled`, and `scope`), its `target`, and a `triggerCount`. Narrow with `kind`: chord views add `parsedChord`, and sequence views add `parsedSequence` and `matchedStepCount`, the number of steps the user has pressed so far. [Show sequences in your UI](./sequences#show-sequences-in-your-ui) uses it to show which keys the user has pressed.

A hotkey that several components register, such as one per list row, appears once for each registration.

If your app uses [scopes](./hotkeys-provider-and-scopes), also leave out hotkeys whose scope is inactive or suspended:

```tsx
import { getHotkeyManager } from '@tanstack/octane-hotkeys'

const manager = getHotkeyManager()

const registrations = useHotkeyRegistrations().hotkeys.filter(
  (reg) =>
    reg.options.meta?.name &&
    reg.options.enabled !== false &&
    manager.isScopeActive(reg.options.scope),
)
```

`useHotkeyRegistrations` updates when scopes change, so the list stays current. [Read scope state](./hotkey-manager#read-scope-state) covers `isScopeActive` and the rest of the manager's scope state.

Registrations exist only while their components are mounted, so this list can't show shortcuts from other pages. To list those, declare them as app hotkeys.

## List every app hotkey

`useAppHotkeyList` returns every app hotkey in declaration order, whether or not anything has registered it. Each item has the `appHotkey`, with its current `hotkey` and its `meta`, plus a `status` and `isCustom`, which is `true` when the user changed the hotkey:

```tsx
import { formatForDisplay, useAppHotkeyList } from '@tanstack/octane-hotkeys'

function CheatSheet() @{
  const items = useAppHotkeyList()

  <ul>
    @for (const item of items; key item.appHotkey.id) {
      <li data-status={item.status}>
        {item.appHotkey.meta?.name}:{' '}
        {item.appHotkey.hotkey ? formatForDisplay(item.appHotkey.hotkey) : 'Unassigned'}
        {item.isCustom ? ' (custom)' : ''}
      </li>
    }
  </ul>
}
```

| Status | Meaning |
| --- | --- |
| `'active'` | At least one enabled registration |
| `'suspended'` | Has an enabled registration, but none in an active scope |
| `'disabled'` | Registered, but every registration has `enabled: false` |
| `'inactive'` | Has a hotkey, but nothing has registered it |
| `'unbound'` | No hotkey assigned |

`useAppHotkeyList` needs a `HotkeysProvider` with `appHotkeys`. An app hotkey that many components register appears once, and its `registrations` array holds each live registration.

To also list hotkeys that aren't app hotkeys, combine both lists. Registrations of app hotkeys have `options.appHotkeyId` set, so skip those:

```tsx
const undeclared = useHotkeyRegistrations().hotkeys.filter(
  (reg) => reg.options.appHotkeyId === undefined && reg.options.meta?.name,
)
```

## Group the list

Group rows by `meta.group`:

```tsx
function CheatSheet() @{
  const items = useAppHotkeyList()
  const groups = [...new Set(items.map((item) => item.appHotkey.meta?.group))]

  @for (const group of groups; key group ?? 'other') {
    <section>
      <h3>{group ?? 'Other'}</h3>
      <ul>
        @for (const item of items.filter((item) => item.appHotkey.meta?.group === group); key item.appHotkey.id) {
          <li>...</li>
        }
      </ul>
    </section>
  }
}
```

To show keycaps, pass `parts: true` to `formatForDisplay` and render each part in its own `<kbd>`. See [Render individual keycaps](./formatting-display#render-individual-keycaps).

## Open the cheat sheet with a hotkey

Register a hotkey that opens the cheat sheet, and give the cheat sheet an exclusive scope. While it's open, the page's hotkeys pause, so a user who presses a shortcut while reading about it doesn't run it behind the dialog:

```tsx
import { useState } from 'octane'
import {
  HotkeysProvider,
  useAppHotkeys,
  useHotkey,
  useHotkeys,
} from '@tanstack/octane-hotkeys'

// Declared with defineAppHotkeys:
// 'help.shortcuts': { hotkey: 'Mod+/', meta: { name: 'Keyboard shortcuts', group: 'Help' } }

function App() @{
  const appHotkeys = useAppHotkeys()
  const [isOpen, setIsOpen] = useState(false)

  useHotkey(appHotkeys['help.shortcuts'], () => setIsOpen(true))

  <>
    <Main />
    @if (isOpen) {
      <HotkeysProvider scope="cheat-sheet" exclusive>
        <CheatSheetDialog onClose={() => setIsOpen(false)} />
      </HotkeysProvider>
    }
  </>
}

function CheatSheetDialog({ onClose }: { onClose: () => void }) @{
  const appHotkeys = useAppHotkeys()

  useHotkeys([
    { hotkey: 'Escape', callback: onClose },
    // The page's registration pauses while the cheat sheet is open, so close from here
    { hotkey: appHotkeys['help.shortcuts'], callback: onClose },
  ])

  <div role="dialog" aria-label="Keyboard shortcuts">
    <CheatSheet />
  </div>
}
```

- The hotkey that opened the cheat sheet pauses with the rest of the page, so register it inside the dialog too, as above, to close the cheat sheet with the same keys.
- `useAppHotkeyList` still lists every app hotkey. While the cheat sheet is open, the ones registered outside it report `'suspended'`, because they can't fire until it closes.
- To keep the page's hotkeys working while the cheat sheet is open, leave out `exclusive`. The cheat sheet's own hotkeys still win, because its scope is newer. See [Exclusive scopes](./hotkeys-provider-and-scopes#exclusive-scopes).

`?` is a common key for opening a cheat sheet. It's a single-key shortcut, so users need a way to turn it off or remap it. See [Single-key shortcuts need an off switch](../../../guides/sensible-defaults.md#single-key-shortcuts-need-an-off-switch).

The [Kitchen Sink example](../examples/kitchen-sink) has a shortcut list built from live registrations.