← Recipes

阅读中文版本

Add a Command Palette with Keyboard Shortcut

Register a Cmd+K shortcut that opens a searchable command palette so power users navigate without touching the mouse.

~25 minfrontenduxcommand-palette

Task

Add useHotkeys('cmd+k', () => setPaletteOpen(true)); so the interface remains usable and accessible under the edge cases that manual testing skips.

When to use this

A screen reader user reports the page is unusable because useHotkeys('cmd+k', () => setPaletteOpen(true)); was never implemented, flagged in a support ticket.

Prerequisites

  • A frontend component or page in the codebase
  • A build with the relevant framework configured

Steps

1. Configure useHotkeys('cmd+k', () => setPaletteOpen(true)); in the project configuration file with the recommended defaults.

useHotkeys('cmd+k', () => setPaletteOpen(true));

Expected output: The configuration is accepted and useHotkeys('cmd+k', () => setPaletteOpen(true)); runs without errors on the first invocation.

2. Run the check locally to verify useHotkeys('cmd+k', () => setPaletteOpen(true)); produces the expected result before pushing.

pnpm test

Expected output: Local run matches CI behavior; no surprises after push.

3. Add the gate to the CI pipeline so useHotkeys('cmd+k', () => setPaletteOpen(true)); blocks merge on failure.

- name: Run add command palette shortcut
  run: pnpm test

Expected output: Pull requests with failing useHotkeys('cmd+k', () => setPaletteOpen(true)); are blocked from merging.

Troubleshooting

Problem

The check passes locally but fails in CI

Solution

Pin dependency versions and the runtime to match CI exactly; reproduce with the same Docker image or act.

Problem

Configuration is rejected with a schema error

Solution

Check the tool version matches the config schema; older versions may not support newer fields.

Limitations

  • The gate only runs on events that trigger the workflow; locally pushed commits bypass it.
  • Configuration drift is possible if someone edits settings outside version control.

Handle the edge case

Start by measuring the problem. Register a Cmd+K shortcut that opens a searchable command palette so power users navigate without touching the mouse. The most common mistake is adding the gate without first confirming it catches the issue you care about. Run useHotkeys(‘cmd+k’, () => setPaletteOpen(true)); against the current codebase and inspect the output before wiring it into CI.

useHotkeys('cmd+k', () => setPaletteOpen(true));

Test with real tools

Once the gate is in place, make failures actionable. A failing useHotkeys(‘cmd+k’, () => setPaletteOpen(true)); should point to the exact file and line, not a generic error. Pin the tool version in the lockfile so a upstream release does not silently change behavior. Review the gate output in every pull request just like a test result.