Skip to content

Add a global keyboard shortcuts cheat-sheet modal (?) with a help link in footer #171

Description

@greatest0fallt1me

Description

This is a UI/UX issue. Discovery of keyboard shortcuts (Cmd-K, ESC to close modal, / to focus search) is currently invisible. Add a "?" shortcut that opens a centered modal listing all global shortcuts in a two-column layout, plus a footer link.

Requirements and Context

  • Reference: src/App.tsx
  • Modal must be focus-trapped, ESC-closeable, restore focus on close
  • Shortcut chord rendered as styled <kbd> elements
  • Skip rendering on touch-only devices
  • Must be secure, tested, and documented
  • Should be efficient and easy to review

Suggested Execution

  1. Fork the repo and create a branch
    git checkout -b feature/shortcuts-cheatsheet
  2. Implement changes
    • src/components/ShortcutsModal.tsx
    • src/App.tsx — register global ? listener
  3. Test and commit
    • Open with ?, close with ESC, verify focus restoration
    • Verify it does not render in iOS Safari touch context

Example commit message

feat: keyboard shortcuts cheat-sheet modal

Acceptance Criteria

  • Pressing ? opens the modal
  • ESC closes and restores focus
  • All shortcuts rendered with <kbd> styling
  • Footer link opens the same modal

Guidelines

  • <kbd> styling token-driven for both themes
  • Avoid keyboard handler conflicts inside input fields
  • Clear documentation and inline comments
  • Timeframe: 96 hours

Metadata

Metadata

Assignees

Labels

GRANTFOX OSSGrantFox open-source campaign taskMAYBE REWARDEDMay be rewarded under the GrantFox campaignOFFICIAL CAMPAIGNOfficial GrantFox campaign issueStellar WaveIssues in the Stellar wave programaccessibilityWCAG 2.1 AA accessibilitydesignVisual/design-system workenhancementNew feature or improvementui/uxUI/UX design, usability, and visual polish

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions