feat(ui): add keyboard shortcut cheatsheet dialog on ? keypress

Shows a beautiful categorized cheatsheet of all keyboard shortcuts
(inbox, issue detail, global) when the user presses ? with keyboard
shortcuts enabled. Respects text input focus detection — won't trigger
in text fields. Uses the existing Dialog component and Radix UI.

Co-Authored-By: Paperclip <noreply@paperclip.ing>
This commit is contained in:
dotta 2026-04-08 08:27:49 -05:00
parent 69ff793c6a
commit fad5634b29
3 changed files with 114 additions and 1 deletions

View file

@ -0,0 +1,100 @@
import { Dialog, DialogContent, DialogHeader, DialogTitle } from "@/components/ui/dialog";
interface ShortcutEntry {
keys: string[];
label: string;
}
interface ShortcutSection {
title: string;
shortcuts: ShortcutEntry[];
}
const sections: ShortcutSection[] = [
{
title: "Inbox",
shortcuts: [
{ keys: ["j"], label: "Move down" },
{ keys: ["k"], label: "Move up" },
{ keys: ["Enter"], label: "Open selected item" },
{ keys: ["a"], label: "Archive item" },
{ keys: ["y"], label: "Archive item" },
{ keys: ["r"], label: "Mark as read" },
{ keys: ["U"], label: "Mark as unread" },
],
},
{
title: "Issue detail",
shortcuts: [
{ keys: ["y"], label: "Quick-archive back to inbox" },
{ keys: ["g", "i"], label: "Go to inbox" },
],
},
{
title: "Global",
shortcuts: [
{ keys: ["c"], label: "New issue" },
{ keys: ["["], label: "Toggle sidebar" },
{ keys: ["]"], label: "Toggle panel" },
{ keys: ["?"], label: "Show keyboard shortcuts" },
],
},
];
function KeyCap({ children }: { children: string }) {
return (
<kbd className="inline-flex h-6 min-w-6 items-center justify-center rounded border border-border bg-muted px-1.5 font-mono text-xs font-medium text-foreground shadow-[0_1px_0_1px_hsl(var(--border))]">
{children}
</kbd>
);
}
export function KeyboardShortcutsCheatsheet({
open,
onOpenChange,
}: {
open: boolean;
onOpenChange: (open: boolean) => void;
}) {
return (
<Dialog open={open} onOpenChange={onOpenChange}>
<DialogContent className="sm:max-w-md gap-0 p-0 overflow-hidden" showCloseButton={false}>
<DialogHeader className="px-5 pt-5 pb-3">
<DialogTitle className="text-base">Keyboard shortcuts</DialogTitle>
</DialogHeader>
<div className="divide-y divide-border border-t border-border">
{sections.map((section) => (
<div key={section.title} className="px-5 py-3">
<h3 className="mb-2 text-[11px] font-semibold uppercase tracking-wider text-muted-foreground">
{section.title}
</h3>
<div className="space-y-1.5">
{section.shortcuts.map((shortcut) => (
<div
key={shortcut.label + shortcut.keys.join()}
className="flex items-center justify-between gap-4"
>
<span className="text-sm text-foreground/90">{shortcut.label}</span>
<div className="flex items-center gap-1">
{shortcut.keys.map((key, i) => (
<span key={key} className="flex items-center gap-1">
{i > 0 && <span className="text-xs text-muted-foreground">then</span>}
<KeyCap>{key}</KeyCap>
</span>
))}
</div>
</div>
))}
</div>
</div>
))}
</div>
<div className="border-t border-border px-5 py-3">
<p className="text-xs text-muted-foreground">
Press <KeyCap>Esc</KeyCap> to close &middot; Shortcuts are disabled in text fields
</p>
</div>
</DialogContent>
</Dialog>
);
}

View file

@ -12,6 +12,7 @@ import { NewIssueDialog } from "./NewIssueDialog";
import { NewProjectDialog } from "./NewProjectDialog";
import { NewGoalDialog } from "./NewGoalDialog";
import { NewAgentDialog } from "./NewAgentDialog";
import { KeyboardShortcutsCheatsheet } from "./KeyboardShortcutsCheatsheet";
import { ToastViewport } from "./ToastViewport";
import { MobileBottomNav } from "./MobileBottomNav";
import { WorktreeBanner } from "./WorktreeBanner";
@ -69,6 +70,7 @@ export function Layout() {
const lastMainScrollTop = useRef(0);
const [mobileNavVisible, setMobileNavVisible] = useState(true);
const [instanceSettingsTarget, setInstanceSettingsTarget] = useState<string>(() => readRememberedInstanceSettingsPath());
const [shortcutsOpen, setShortcutsOpen] = useState(false);
const nextTheme = theme === "dark" ? "light" : "dark";
const matchedCompany = useMemo(() => {
if (!companyPrefix) return null;
@ -151,6 +153,7 @@ export function Layout() {
onNewIssue: () => openNewIssue(),
onToggleSidebar: toggleSidebar,
onTogglePanel: togglePanel,
onShowShortcuts: () => setShortcutsOpen(true),
});
useEffect(() => {
@ -443,6 +446,7 @@ export function Layout() {
<NewProjectDialog />
<NewGoalDialog />
<NewAgentDialog />
<KeyboardShortcutsCheatsheet open={shortcutsOpen} onOpenChange={setShortcutsOpen} />
<ToastViewport />
</div>
</GeneralSettingsProvider>

View file

@ -6,6 +6,7 @@ interface ShortcutHandlers {
onNewIssue?: () => void;
onToggleSidebar?: () => void;
onTogglePanel?: () => void;
onShowShortcuts?: () => void;
}
export function useKeyboardShortcuts({
@ -13,6 +14,7 @@ export function useKeyboardShortcuts({
onNewIssue,
onToggleSidebar,
onTogglePanel,
onShowShortcuts,
}: ShortcutHandlers) {
useEffect(() => {
if (!enabled) return;
@ -23,6 +25,13 @@ export function useKeyboardShortcuts({
return;
}
// ? → Show keyboard shortcuts cheatsheet
if (e.key === "?" && !e.metaKey && !e.ctrlKey && !e.altKey) {
e.preventDefault();
onShowShortcuts?.();
return;
}
// C → New Issue
if (e.key === "c" && !e.metaKey && !e.ctrlKey && !e.altKey) {
e.preventDefault();
@ -44,5 +53,5 @@ export function useKeyboardShortcuts({
document.addEventListener("keydown", handleKeyDown);
return () => document.removeEventListener("keydown", handleKeyDown);
}, [enabled, onNewIssue, onToggleSidebar, onTogglePanel]);
}, [enabled, onNewIssue, onToggleSidebar, onTogglePanel, onShowShortcuts]);
}