Skip to content

Email for professionals and teams

refactor(shortcuts): break down command palette into modular item and utility components

ivie69f32f1d9da
diff --git a/drizzle/migrations/0028_add_keyboard_shortcuts_setting.sql b/drizzle/migrations/0028_add_keyboard_shortcuts_setting.sql
new file mode 100644
index 0000000..911c105
--- /dev/null
+++ b/drizzle/migrations/0028_add_keyboard_shortcuts_setting.sql
@@ -0,0 +1 @@
+ALTER TABLE `users` ADD `keyboard_shortcuts_enabled` integer DEFAULT true NOT NULL;
diff --git a/drizzle/migrations/meta/_journal.json b/drizzle/migrations/meta/_journal.json
index 25ca24e..0f60979 100644
--- a/drizzle/migrations/meta/_journal.json
+++ b/drizzle/migrations/meta/_journal.json
@@ -197,6 +197,13 @@
"when": 1788796800000,
"tag": "0027_add_domain_sending_intent",
"breakpoints": true
+ },
+ {
+ "idx": 28,
+ "version": "6",
+ "when": 1788850800000,
+ "tag": "0028_add_keyboard_shortcuts_setting",
+ "breakpoints": true
}
]
}
diff --git a/src/app/(admin)/layout.tsx b/src/app/(admin)/layout.tsx
index b6c6d4d..2d55e2f 100644
--- a/src/app/(admin)/layout.tsx
+++ b/src/app/(admin)/layout.tsx
@@ -10,6 +10,7 @@ import { MailboxSelector } from "@/components/mailbox-selector";
import { LicenseIndicator } from "@/components/license-indicator";
import { AdminNav } from "@/components/admin-nav";
import { SidebarProvider } from "@/components/sidebar-state";
+import { ShortcutsProvider } from "@/components/shortcuts";
export default function DashboardLayout({
children,
@@ -21,6 +22,7 @@ export default function DashboardLayout({
<SidebarProvider expandedWidth={256}>
<MailboxProvider>
<ComposeProvider>
+ <ShortcutsProvider>
<div className="grid h-dvh grid-cols-[var(--sidebar-width)_minmax(0,1fr)] overflow-hidden bg-[#f6f8fc] transition-[grid-template-columns] duration-200">
<aside className="min-h-0 overflow-y-auto overscroll-contain px-3 py-4 scrollbar-gutter-stable">
<AdminNav />
@@ -36,6 +38,7 @@ export default function DashboardLayout({
</div>
<FloatingComposer />
</div>
+ </ShortcutsProvider>
</ComposeProvider>
</MailboxProvider>
</SidebarProvider>
diff --git a/src/app/(settings)/layout.tsx b/src/app/(settings)/layout.tsx
index e66d4ce..48bd333 100644
--- a/src/app/(settings)/layout.tsx
+++ b/src/app/(settings)/layout.tsx
@@ -12,6 +12,7 @@ import { MailboxSelector } from "@/components/mailbox-selector";
import { LicenseIndicator } from "@/components/license-indicator";
import { DashboardNav } from "@/components/dashboard-nav";
import { SidebarProvider } from "@/components/sidebar-state";
+import { ShortcutsProvider } from "@/components/shortcuts";
export default function DashboardLayout({
children,
@@ -24,6 +25,7 @@ export default function DashboardLayout({
<MailboxProvider>
<ComposeProvider>
<MailSearchProvider>
+ <ShortcutsProvider>
<div className="grid h-[100dvh] grid-cols-[var(--sidebar-width)_minmax(0,1fr)] overflow-hidden bg-[#f6f8fc] transition-[grid-template-columns] duration-200">
<aside className="min-h-0 overflow-y-auto overscroll-contain px-3 py-4 [scrollbar-gutter:stable]">
<DashboardNav />
@@ -46,6 +48,7 @@ export default function DashboardLayout({
</div>
<FloatingComposer />
</div>
+ </ShortcutsProvider>
</MailSearchProvider>
</ComposeProvider>
</MailboxProvider>
diff --git a/src/app/(settings)/settings/inbox/page.tsx b/src/app/(settings)/settings/inbox/page.tsx
index 785cedf..67cb62f 100644
--- a/src/app/(settings)/settings/inbox/page.tsx
+++ b/src/app/(settings)/settings/inbox/page.tsx
@@ -1,4 +1,5 @@
import { InboxThreadingSettings } from "@/components/settings/inbox-threading-settings";
+import { InboxShortcutsSettings } from "@/components/settings/inbox-shortcuts-settings";
import { MailboxAutoReplyForm } from "@/components/settings/mailbox-auto-reply-form";
export default function SettingsInboxPage() {
@@ -14,6 +15,16 @@ export default function SettingsInboxPage() {
</div>
</section>
+ <section className="space-y-4">
+ <div>
+ <h2 className="text-xl font-semibold text-neutral-900">Shortcuts</h2>
+ <p className="mt-1 text-sm text-neutral-500">Choose whether keyboard shortcuts are active.</p>
+ </div>
+ <div className="rounded-3xl bg-white p-6">
+ <InboxShortcutsSettings />
+ </div>
+ </section>
+
<section className="space-y-4">
<div>
<h2 className="text-xl font-semibold text-neutral-900">Automatic response</h2>
diff --git a/src/app/api/auth/me/route.ts b/src/app/api/auth/me/route.ts
index 7ce527f..66fd685 100644
--- a/src/app/api/auth/me/route.ts
+++ b/src/app/api/auth/me/route.ts
@@ -32,6 +32,7 @@ export async function GET(request: Request) {
canForwardEmail: entitlements.canForwardEmail,
role: user.role,
canManageMailboxes: user.canManageMailboxes,
+ keyboardShortcutsEnabled: user.keyboardShortcutsEnabled,
hasAvatar: !!user.avatarKey,
},
hasMailboxes,
diff --git a/src/app/api/settings/shortcuts/route.ts b/src/app/api/settings/shortcuts/route.ts
new file mode 100644
index 0000000..09c3323
--- /dev/null
+++ b/src/app/api/settings/shortcuts/route.ts
@@ -0,0 +1,40 @@
+import { eq } from "drizzle-orm";
+import { NextResponse } from "next/server";
+import { ZodError } from "zod";
+import { getDb } from "@/db";
+import { users } from "@/db/schema";
+import { requireSessionUser } from "@/lib/api/auth";
+import { getEnv } from "@/lib/cloudflare";
+import type { UpdateShortcutsSettingsInput } from "./types";
+import { parseUpdateShortcutsSettingsRequest } from "./utils";
+
+export async function GET(request: Request) {
+ const env = getEnv();
+ const auth = await requireSessionUser(env, request);
+ if (auth.error) return auth.error;
+
+ return NextResponse.json({ enabled: auth.user.keyboardShortcutsEnabled });
+}
+
+export async function PATCH(request: Request) {
+ const env = getEnv();
+ const auth = await requireSessionUser(env, request);
+ if (auth.error) return auth.error;
+
+ let input: UpdateShortcutsSettingsInput;
+ try {
+ input = await parseUpdateShortcutsSettingsRequest(request);
+ } catch (error) {
+ if (error instanceof ZodError) {
+ return NextResponse.json({ error: error.flatten() }, { status: 400 });
+ }
+ return NextResponse.json({ error: "Invalid request" }, { status: 400 });
+ }
+
+ await getDb(env)
+ .update(users)
+ .set({ keyboardShortcutsEnabled: input.enabled })
+ .where(eq(users.id, auth.user.id));
+
+ return NextResponse.json({ enabled: input.enabled });
+}
diff --git a/src/app/api/settings/shortcuts/types.d.ts b/src/app/api/settings/shortcuts/types.d.ts
new file mode 100644
index 0000000..803806e
--- /dev/null
+++ b/src/app/api/settings/shortcuts/types.d.ts
@@ -0,0 +1,4 @@
+import type { updateShortcutsSettingsSchema } from "@/lib/validators";
+import type { z } from "zod";
+
+export type UpdateShortcutsSettingsInput = z.infer<typeof updateShortcutsSettingsSchema>;
diff --git a/src/app/api/settings/shortcuts/utils.ts b/src/app/api/settings/shortcuts/utils.ts
new file mode 100644
index 0000000..9161c9e
--- /dev/null
+++ b/src/app/api/settings/shortcuts/utils.ts
@@ -0,0 +1,8 @@
+import { updateShortcutsSettingsSchema } from "@/lib/validators";
+import type { UpdateShortcutsSettingsInput } from "./types";
+
+export async function parseUpdateShortcutsSettingsRequest(
+ request: Request,
+): Promise<UpdateShortcutsSettingsInput> {
+ return updateShortcutsSettingsSchema.parse(await request.json());
+}
diff --git a/src/components/mail-search/mail-search-input.tsx b/src/components/mail-search/mail-search-input.tsx
index a3a7173..ef22f77 100644
--- a/src/components/mail-search/mail-search-input.tsx
+++ b/src/components/mail-search/mail-search-input.tsx
@@ -7,7 +7,8 @@ import { useShortcuts } from "@/components/shortcuts";
export function MailSearchInput() {
const { query, setQuery } = useMailSearch();
- const { openCommandPalette } = useShortcuts();
+ const { openCommandPalette, shortcutsEnabled, shortcutsPreferenceLoading } = useShortcuts();
+ const showShortcutHints = shortcutsEnabled && !shortcutsPreferenceLoading;
return (
<div className="flex h-12 flex-1 items-center gap-2.5 rounded-full bg-[#eaf1fb] px-4 text-neutral-600 focus-within:ring-2 focus-within:ring-blue-500/30 transition-all">
@@ -15,7 +16,7 @@ export function MailSearchInput() {
<Input
value={query}
onChange={(event) => setQuery(event.target.value)}
- placeholder="Search mail (press / to focus)"
+ placeholder={showShortcutHints ? "Search mail (press / to focus)" : "Search mail"}
className="h-full min-w-0 flex-1 bg-transparent text-[15px] text-neutral-800 outline-none! shadow-none! border-none! placeholder:text-neutral-500"
/>
{query ? (
@@ -27,7 +28,7 @@ export function MailSearchInput() {
>
<X className="h-4 w-4" />
</button>
- ) : (
+ ) : showShortcutHints ? (
<button
type="button"
onClick={openCommandPalette}
@@ -36,7 +37,7 @@ export function MailSearchInput() {
>
<span className="text-[11px] font-mono">⌘K</span>
</button>
- )}
+ ) : null}
</div>
);
}
diff --git a/src/components/message-actions/message-actions.tsx b/src/components/message-actions/message-actions.tsx
index 17ec59a..27a07b9 100644
--- a/src/components/message-actions/message-actions.tsx
+++ b/src/components/message-actions/message-actions.tsx
@@ -4,7 +4,7 @@ import { createElement, useState, useMemo, useCallback } from "react";
import { useRouter } from "next/navigation";
import { Archive, Ban, BellOff, Forward, Mail, MailOpen, MoreVertical, Reply, ReplyAll, ShieldAlert, Trash2 } from "lucide-react";
import { useCompose } from "@/components/compose/compose-context";
-import { useHotkeys } from "@/components/shortcuts";
+import { useHotkeys, useShortcuts } from "@/components/shortcuts";
import { Button } from "@/components/ui/button";
import { Tooltip } from "@/components/ui/tooltip";
import type { BulkMessageAction } from "@/app/api/messages/bulk/types";
@@ -42,6 +42,7 @@ export function MessageActions({
}: MessageActionsProps) {
const router = useRouter();
const { openDraftComposer } = useCompose();
+ const { shortcutsEnabled } = useShortcuts();
const [pendingAction, setPendingAction] = useState<
BulkMessageAction | "unsubscribe" | ReplyMode | "forward" | "block" | null
>(null);
@@ -148,7 +149,7 @@ export function MessageActions({
[status, direction, runAction, handleReply, router]
);
- useHotkeys(shortcuts);
+ useHotkeys(shortcuts, { enabled: shortcutsEnabled });
async function onUnsubscribe() {
setMoreOpen(false);
@@ -223,12 +224,12 @@ export function MessageActions({
<div className="flex items-center gap-3 text-neutral-600">
{error && <span className="text-xs text-red-600">{error}</span>}
<div className="flex items-center gap-2">
- <Tooltip label="Reply (r)">
+ <Tooltip label={shortcutsEnabled ? "Reply (r)" : "Reply"}>
<Button
type="button"
variant="ghost"
size="sm"
- aria-label="Reply (r)"
+ aria-label={shortcutsEnabled ? "Reply (r)" : "Reply"}
disabled={disabled}
onClick={() => handleReply("reply")}
>
@@ -263,33 +264,33 @@ export function MessageActions({
</Button>
</Tooltip>
)}
- <Tooltip label="Archive (e)">
+ <Tooltip label={shortcutsEnabled ? "Archive (e)" : "Archive"}>
<Button
variant="ghost"
size="sm"
- aria-label="Archive (e)"
+ aria-label={shortcutsEnabled ? "Archive (e)" : "Archive"}
disabled={disabled || status === "archived"}
onClick={() => runAction("archive")}
>
<Archive className="h-5 w-5" />
</Button>
</Tooltip>
- <Tooltip label="Report spam (!)">
+ <Tooltip label={shortcutsEnabled ? "Report spam (!)" : "Report spam"}>
<Button
variant="ghost"
size="sm"
- aria-label="Report spam (!)"
+ aria-label={shortcutsEnabled ? "Report spam (!)" : "Report spam"}
disabled={disabled || status === "spam" || direction !== "inbound"}
onClick={() => runAction("spam")}
>
<ShieldAlert className="h-5 w-5" />
</Button>
</Tooltip>
- <Tooltip label="Delete (#)">
+ <Tooltip label={shortcutsEnabled ? "Delete (#)" : "Delete"}>
<Button
variant="ghost"
size="sm"
- aria-label="Move to trash (#)"
+ aria-label={shortcutsEnabled ? "Move to trash (#)" : "Move to trash"}
disabled={disabled || status === "trash"}
onClick={() => runAction("trash")}
>
diff --git a/src/components/settings/inbox-shortcuts-settings.tsx b/src/components/settings/inbox-shortcuts-settings.tsx
new file mode 100644
index 0000000..0c9048e
--- /dev/null
+++ b/src/components/settings/inbox-shortcuts-settings.tsx
@@ -0,0 +1,44 @@
+"use client";
+
+import { useState } from "react";
+import { useShortcuts } from "@/components/shortcuts";
+import { Switch } from "@/components/ui/switch";
+
+export function InboxShortcutsSettings() {
+ const {
+ shortcutsEnabled,
+ shortcutsPreferenceLoading,
+ shortcutsPreferenceError,
+ setShortcutsEnabled,
+ } = useShortcuts();
+ const [saving, setSaving] = useState(false);
+ const [saveError, setSaveError] = useState<string | null>(null);
+
+ return (
+ <div>
+ <label className="flex items-start gap-3 rounded-xl bg-neutral-50 p-4">
+ <span className="flex-1">
+ <span className="block text-sm font-medium text-neutral-900">Keyboard shortcuts</span>
+ <span className="mt-1 block text-sm text-neutral-500">
+ Use quick keys to navigate, compose, and manage messages on this account.
+ </span>
+ </span>
+ <Switch
+ checked={shortcutsEnabled}
+ disabled={shortcutsPreferenceLoading || saving}
+ onCheckedChange={(enabled) => {
+ setSaving(true);
+ setSaveError(null);
+ void setShortcutsEnabled(enabled)
+ .catch((error) => setSaveError(error instanceof Error ? error.message : "Failed to update shortcut settings"))
+ .finally(() => setSaving(false));
+ }}
+ aria-label="Enable keyboard shortcuts"
+ />
+ </label>
+ {(saveError || shortcutsPreferenceError) && (
+ <p className="mt-2 px-4 text-sm text-red-600">{saveError || shortcutsPreferenceError}</p>
+ )}
+ </div>
+ );
+}
diff --git a/src/components/shortcuts/command-palette-item.tsx b/src/components/shortcuts/command-palette-item.tsx
new file mode 100644
index 0000000..f603d97
--- /dev/null
+++ b/src/components/shortcuts/command-palette-item.tsx
@@ -0,0 +1,70 @@
+"use client";
+
+import React from "react";
+import type { CommandItem } from "./types";
+
+interface CommandPaletteItemProps {
+ item: CommandItem;
+ isActive: boolean;
+ onSelect: () => void;
+ onHover: () => void;
+}
+
+export function CommandPaletteItem({
+ item,
+ isActive,
+ onSelect,
+ onHover,
+}: CommandPaletteItemProps) {
+ const Icon = item.icon;
+
+ return (
+ <button
+ type="button"
+ onClick={onSelect}
+ onMouseEnter={onHover}
+ className={`w-full text-left px-3 py-2.5 rounded-xl flex items-center justify-between transition-colors ${
+ isActive
+ ? "bg-blue-600 text-white"
+ : "text-neutral-800 dark:text-neutral-200 hover:bg-neutral-100 dark:hover:bg-neutral-800/70"
+ }`}
+ >
+ <div className="flex items-center gap-3 min-w-0">
+ {Icon && (
+ <Icon
+ className={`w-4 h-4 shrink-0 ${
+ isActive
+ ? "text-white"
+ : "text-neutral-500 dark:text-neutral-400"
+ }`}
+ />
+ )}
+ <div className="truncate">
+ <span className="text-sm font-medium">{item.title}</span>
+ {item.subtitle && (
+ <span
+ className={`ml-2 text-xs truncate ${
+ isActive
+ ? "text-blue-100"
+ : "text-neutral-400 dark:text-neutral-500"
+ }`}
+ >
+ {item.subtitle}
+ </span>
+ )}
+ </div>
+ </div>
+ {item.shortcut && (
+ <kbd
+ className={`text-xs px-2 py-0.5 rounded-md font-mono font-medium shrink-0 ${
+ isActive
+ ? "bg-blue-700 text-blue-100"
+ : "bg-neutral-100 dark:bg-neutral-800 text-neutral-500 dark:text-neutral-400 border border-neutral-200 dark:border-neutral-700"
+ }`}
+ >
+ {item.shortcut}
+ </kbd>
+ )}
+ </button>
+ );
+}
diff --git a/src/components/shortcuts/command-palette-utils.ts b/src/components/shortcuts/command-palette-utils.ts
new file mode 100644
index 0000000..cb0b8c6
--- /dev/null
+++ b/src/components/shortcuts/command-palette-utils.ts
@@ -0,0 +1,33 @@
+import type { CommandItem } from "./types";
+
+/**
+ * Filter commands by matching title, subtitle, category, or keywords.
+ */
+export function filterCommands(commands: CommandItem[], query: string): CommandItem[] {
+ const trimmed = query.trim();
+ if (!trimmed) return commands;
+ const lowerQuery = trimmed.toLowerCase();
+
+ return commands.filter((cmd) => {
+ const matchTitle = cmd.title.toLowerCase().includes(lowerQuery);
+ const matchSubtitle = cmd.subtitle?.toLowerCase().includes(lowerQuery);
+ const matchCategory = cmd.category.toLowerCase().includes(lowerQuery);
+ const matchKeywords = cmd.keywords?.some((k) =>
+ k.toLowerCase().includes(lowerQuery)
+ );
+ return matchTitle || matchSubtitle || matchCategory || matchKeywords;
+ });
+}
+
+/**
+ * Group commands by their category string.
+ */
+export function groupCommandsByCategory(
+ commands: CommandItem[]
+): Record<string, CommandItem[]> {
+ return commands.reduce((acc, item) => {
+ if (!acc[item.category]) acc[item.category] = [];
+ acc[item.category].push(item);
+ return acc;
+ }, {} as Record<string, CommandItem[]>);
+}
diff --git a/src/components/shortcuts/command-palette.tsx b/src/components/shortcuts/command-palette.tsx
index 3293cce..19f1cf4 100644
--- a/src/components/shortcuts/command-palette.tsx
+++ b/src/components/shortcuts/command-palette.tsx
@@ -3,6 +3,8 @@
import React, { useState, useEffect, useRef, useMemo } from "react";
import { Search, CornerDownLeft } from "lucide-react";
import type { CommandItem } from "./types";
+import { filterCommands, groupCommandsByCategory } from "./command-palette-utils";
+import { CommandPaletteItem } from "./command-palette-item";
interface CommandPaletteProps {
isOpen: boolean;
@@ -20,25 +22,15 @@ function CommandPaletteDialog({
const [query, setQuery] = useState("");
const [selectedIndex, setSelectedIndex] = useState(0);
const inputRef = useRef<HTMLInputElement>(null);
- const listRef = useRef<HTMLDivElement>(null);
useEffect(() => {
inputRef.current?.focus();
}, []);
- const filteredCommands = useMemo(() => {
- if (!query.trim()) return commands;
- const lowerQuery = query.toLowerCase();
- return commands.filter((cmd) => {
- const matchTitle = cmd.title.toLowerCase().includes(lowerQuery);
- const matchSubtitle = cmd.subtitle?.toLowerCase().includes(lowerQuery);
- const matchCategory = cmd.category.toLowerCase().includes(lowerQuery);
- const matchKeywords = cmd.keywords?.some((k) =>
- k.toLowerCase().includes(lowerQuery)
- );
- return matchTitle || matchSubtitle || matchCategory || matchKeywords;
- });
- }, [commands, query]);
+ const filteredCommands = useMemo(
+ () => filterCommands(commands, query),
+ [commands, query]
+ );
const activeIndex = Math.min(
selectedIndex,
@@ -66,21 +58,16 @@ function CommandPaletteDialog({
}
};
- const grouped = filteredCommands.reduce((acc, item) => {
- if (!acc[item.category]) acc[item.category] = [];
- acc[item.category].push(item);
- return acc;
- }, {} as Record<string, CommandItem[]>);
+ const grouped = useMemo(
+ () => groupCommandsByCategory(filteredCommands),
+ [filteredCommands]
+ );
let flatIndex = 0;
return (
<div className="fixed inset-0 z-50 flex items-start justify-center pt-24 px-4 bg-neutral-900/40 backdrop-blur-xs animate-in fade-in duration-100">
- <div
- className="fixed inset-0"
- onClick={onClose}
- aria-hidden="true"
- />
+ <div className="fixed inset-0" onClick={onClose} aria-hidden="true" />
<div
className="relative w-full max-w-xl bg-white dark:bg-neutral-900 border border-neutral-200 dark:border-neutral-800 rounded-2xl shadow-2xl overflow-hidden flex flex-col z-10"
onKeyDown={handleKeyDown}
@@ -105,10 +92,7 @@ function CommandPaletteDialog({
</div>
{/* Results */}
- <div
- ref={listRef}
- className="max-h-80 overflow-y-auto p-2"
- >
+ <div className="max-h-80 overflow-y-auto p-2">
{filteredCommands.length === 0 ? (
<div className="p-8 text-center text-sm text-neutral-400">
No matching commands found for &ldquo;{query}&rdquo;
@@ -123,60 +107,18 @@ function CommandPaletteDialog({
const isCurrent = flatIndex === activeIndex;
const itemIndex = flatIndex;
flatIndex++;
- const Icon = item.icon;
return (
- <button
+ <CommandPaletteItem
key={item.id}
- type="button"
- onClick={() => {
+ item={item}
+ isActive={isCurrent}
+ onSelect={() => {
item.perform();
onClose();
}}
- onMouseEnter={() => setSelectedIndex(itemIndex)}
- className={`w-full text-left px-3 py-2.5 rounded-xl flex items-center justify-between transition-colors ${
- isCurrent
- ? "bg-blue-600 text-white"
- : "text-neutral-800 dark:text-neutral-200 hover:bg-neutral-100 dark:hover:bg-neutral-800/70"
- }`}
- >
- <div className="flex items-center gap-3 min-w-0">
- {Icon && (
- <Icon
- className={`w-4 h-4 shrink-0 ${
- isCurrent
- ? "text-white"
- : "text-neutral-500 dark:text-neutral-400"
- }`}
- />
- )}
- <div className="truncate">
- <span className="text-sm font-medium">{item.title}</span>
- {item.subtitle && (
- <span
- className={`ml-2 text-xs truncate ${
- isCurrent
- ? "text-blue-100"
- : "text-neutral-400 dark:text-neutral-500"
- }`}
- >
- {item.subtitle}
- </span>
- )}
- </div>
- </div>
- {item.shortcut && (
- <kbd
- className={`text-xs px-2 py-0.5 rounded-md font-mono font-medium shrink-0 ${
- isCurrent
- ? "bg-blue-700 text-blue-100"
- : "bg-neutral-100 dark:bg-neutral-800 text-neutral-500 dark:text-neutral-400 border border-neutral-200 dark:border-neutral-700"
- }`}
- >
- {item.shortcut}
- </kbd>
- )}
- </button>
+ onHover={() => setSelectedIndex(itemIndex)}
+ />
);
})}
</div>
diff --git a/src/components/shortcuts/index.ts b/src/components/shortcuts/index.ts
index bfab0b1..377fff9 100644
--- a/src/components/shortcuts/index.ts
+++ b/src/components/shortcuts/index.ts
@@ -1,5 +1,8 @@
export * from "./types";
export * from "./use-hotkeys";
+export * from "./use-shortcuts-enabled";
export * from "./shortcuts-context";
export * from "./command-palette";
+export * from "./command-palette-item";
+export * from "./command-palette-utils";
export * from "./shortcuts-help-dialog";
diff --git a/src/components/shortcuts/shortcuts-context.tsx b/src/components/shortcuts/shortcuts-context.tsx
index bf22eac..34fa570 100644
--- a/src/components/shortcuts/shortcuts-context.tsx
+++ b/src/components/shortcuts/shortcuts-context.tsx
@@ -20,8 +20,13 @@ import type { ShortcutDefinition, CommandItem } from "./types";
import { useHotkeys } from "./use-hotkeys";
import { CommandPalette } from "./command-palette";
import { ShortcutsHelpDialog } from "./shortcuts-help-dialog";
+import { useShortcutsEnabled } from "./use-shortcuts-enabled";
interface ShortcutsContextValue {
+ shortcutsEnabled: boolean;
+ shortcutsPreferenceLoading: boolean;
+ shortcutsPreferenceError: string | null;
+ setShortcutsEnabled: (enabled: boolean) => Promise<void>;
openCommandPalette: () => void;
closeCommandPalette: () => void;
openHelpModal: () => void;
@@ -53,15 +58,25 @@ export function ShortcutsProvider({
}) {
const router = useRouter();
const { openComposer } = useCompose();
+ const {
+ enabled: shortcutsEnabled,
+ error: shortcutsPreferenceError,
+ isLoading: shortcutsPreferenceLoading,
+ setEnabled: setShortcutsEnabled,
+ } = useShortcutsEnabled();
const [isCommandPaletteOpen, setIsCommandPaletteOpen] = useState(false);
const [isHelpModalOpen, setIsHelpModalOpen] = useState(false);
const [customShortcuts, setCustomShortcuts] = useState<ShortcutDefinition[]>(extraShortcuts);
const [customCommands, setCustomCommands] = useState<CommandItem[]>(extraCommands);
- const openCommandPalette = () => setIsCommandPaletteOpen(true);
+ const openCommandPalette = () => {
+ if (shortcutsEnabled && !shortcutsPreferenceLoading) setIsCommandPaletteOpen(true);
+ };
const closeCommandPalette = () => setIsCommandPaletteOpen(false);
- const openHelpModal = () => setIsHelpModalOpen(true);
+ const openHelpModal = () => {
+ if (shortcutsEnabled && !shortcutsPreferenceLoading) setIsHelpModalOpen(true);
+ };
const closeHelpModal = () => setIsHelpModalOpen(false);
const registerShortcut = (shortcut: ShortcutDefinition) => {
@@ -185,7 +200,7 @@ export function ShortcutsProvider({
];
}, [router, openComposer, customShortcuts]);
- useHotkeys(baseShortcuts, { enabled: true });
+ useHotkeys(baseShortcuts, { enabled: shortcutsEnabled && !shortcutsPreferenceLoading });
// Base Command Palette actions
const allCommands = useMemo<CommandItem[]>(() => {
@@ -288,6 +303,10 @@ export function ShortcutsProvider({
return (
<ShortcutsContext.Provider
value={{
+ shortcutsEnabled,
+ shortcutsPreferenceLoading,
+ shortcutsPreferenceError,
+ setShortcutsEnabled,
openCommandPalette,
closeCommandPalette,
openHelpModal,
@@ -299,16 +318,20 @@ export function ShortcutsProvider({
}}
>
{children}
- <CommandPalette
- isOpen={isCommandPaletteOpen}
- onClose={closeCommandPalette}
- commands={allCommands}
- />
- <ShortcutsHelpDialog
- isOpen={isHelpModalOpen}
- onClose={closeHelpModal}
- shortcuts={baseShortcuts}
- />
+ {shortcutsEnabled && !shortcutsPreferenceLoading && (
+ <>
+ <CommandPalette
+ isOpen={isCommandPaletteOpen}
+ onClose={closeCommandPalette}
+ commands={allCommands}
+ />
+ <ShortcutsHelpDialog
+ isOpen={isHelpModalOpen}
+ onClose={closeHelpModal}
+ shortcuts={baseShortcuts}
+ />
+ </>
+ )}
</ShortcutsContext.Provider>
);
}
diff --git a/src/components/shortcuts/types.ts b/src/components/shortcuts/types.ts
index 97abb97..81b6649 100644
--- a/src/components/shortcuts/types.ts
+++ b/src/components/shortcuts/types.ts
@@ -22,3 +22,8 @@ export interface CommandItem {
keywords?: string[];
perform: () => void;
}
+
+export interface ShortcutsSettingsResponse {
+ enabled?: boolean;
+ error?: unknown;
+}
diff --git a/src/components/shortcuts/use-shortcuts-enabled-utils.ts b/src/components/shortcuts/use-shortcuts-enabled-utils.ts
new file mode 100644
index 0000000..bc44edf
--- /dev/null
+++ b/src/components/shortcuts/use-shortcuts-enabled-utils.ts
@@ -0,0 +1,24 @@
+import { authFetch } from "@/lib/auth/client";
+import type { ShortcutsSettingsResponse } from "./types";
+
+export async function loadShortcutsEnabled(): Promise<boolean> {
+ const response = await authFetch("/api/settings/shortcuts");
+ const data = (await response.json()) as ShortcutsSettingsResponse;
+ if (!response.ok || typeof data.enabled !== "boolean") {
+ throw new Error(typeof data.error === "string" ? data.error : "Failed to load shortcut settings");
+ }
+ return data.enabled;
+}
+
+export async function updateShortcutsEnabled(enabled: boolean): Promise<boolean> {
+ const response = await authFetch("/api/settings/shortcuts", {
+ method: "PATCH",
+ headers: { "Content-Type": "application/json" },
+ body: JSON.stringify({ enabled }),
+ });
+ const data = (await response.json()) as ShortcutsSettingsResponse;
+ if (!response.ok || typeof data.enabled !== "boolean") {
+ throw new Error(typeof data.error === "string" ? data.error : "Failed to update shortcut settings");
+ }
+ return data.enabled;
+}
diff --git a/src/components/shortcuts/use-shortcuts-enabled.ts b/src/components/shortcuts/use-shortcuts-enabled.ts
new file mode 100644
index 0000000..5044f16
--- /dev/null
+++ b/src/components/shortcuts/use-shortcuts-enabled.ts
@@ -0,0 +1,46 @@
+"use client";
+
+import { useCallback, useEffect, useState } from "react";
+import { loadShortcutsEnabled, updateShortcutsEnabled } from "./use-shortcuts-enabled-utils";
+
+/** Loads and updates the signed-in account's keyboard shortcut preference. */
+export function useShortcutsEnabled() {
+ const [enabled, setEnabledState] = useState(false);
+ const [isLoading, setIsLoading] = useState(true);
+ const [error, setError] = useState<string | null>(null);
+
+ useEffect(() => {
+ let cancelled = false;
+ loadShortcutsEnabled()
+ .then((storedEnabled) => {
+ if (!cancelled) setEnabledState(storedEnabled);
+ })
+ .catch((loadError) => {
+ if (cancelled) return;
+ setEnabledState(true);
+ setError(loadError instanceof Error ? loadError.message : "Failed to load shortcut settings");
+ })
+ .finally(() => {
+ if (!cancelled) setIsLoading(false);
+ });
+ return () => {
+ cancelled = true;
+ };
+ }, []);
+
+ const setEnabled = useCallback(async (next: boolean) => {
+ const previous = enabled;
+ setEnabledState(next);
+ setError(null);
+ try {
+ setEnabledState(await updateShortcutsEnabled(next));
+ } catch (updateError) {
+ setEnabledState(previous);
+ const message = updateError instanceof Error ? updateError.message : "Failed to update shortcut settings";
+ setError(message);
+ throw new Error(message);
+ }
+ }, [enabled]);
+
+ return { enabled, error, isLoading, setEnabled };
+}
diff --git a/src/components/sidebar-footer.tsx b/src/components/sidebar-footer.tsx
index faef89d..b2b62ed 100644
--- a/src/components/sidebar-footer.tsx
+++ b/src/components/sidebar-footer.tsx
@@ -7,24 +7,26 @@ import { Keyboard } from "lucide-react";
export function SidebarFooter() {
const { minimal } = useSidebar();
- const { openHelpModal } = useShortcuts();
+ const { openHelpModal, shortcutsEnabled, shortcutsPreferenceLoading } = useShortcuts();
if (minimal) return null;
return (
<div className="px-3 pt-3 flex flex-col gap-2">
- <button
- type="button"
- onClick={openHelpModal}
- className="flex items-center justify-between w-full px-2.5 py-1.5 text-xs text-neutral-500 hover:text-neutral-800 hover:bg-neutral-200/60 rounded-lg transition-colors"
- >
- <span className="flex items-center gap-1.5">
- <Keyboard className="w-3.5 h-3.5 text-neutral-400" />
- Shortcuts
- </span>
- <kbd className="px-1.5 py-0.5 font-mono text-[10px] bg-white border border-neutral-200 rounded text-neutral-500 shadow-2xs">
- ?
- </kbd>
- </button>
+ {shortcutsEnabled && !shortcutsPreferenceLoading && (
+ <button
+ type="button"
+ onClick={openHelpModal}
+ className="flex items-center justify-between w-full px-2.5 py-1.5 text-xs text-neutral-500 hover:text-neutral-800 hover:bg-neutral-200/60 rounded-lg transition-colors"
+ >
+ <span className="flex items-center gap-1.5">
+ <Keyboard className="w-3.5 h-3.5 text-neutral-400" />
+ Shortcuts
+ </span>
+ <kbd className="px-1.5 py-0.5 font-mono text-[10px] bg-white border border-neutral-200 rounded text-neutral-500 shadow-2xs">
+ ?
+ </kbd>
+ </button>
+ )}
<p className="px-1 text-[11px] text-neutral-400">
Powered by{" "}
<a
diff --git a/src/db/schema/index.ts b/src/db/schema/index.ts
index d8d9b1e..1cb24a8 100644
--- a/src/db/schema/index.ts
+++ b/src/db/schema/index.ts
@@ -12,6 +12,7 @@ export const users = sqliteTable("users", {
role: text("role", { enum: ["admin", "user"] }).notNull().default("user"),
disabled: integer("disabled", { mode: "boolean" }).notNull().default(false),
canManageMailboxes: integer("can_manage_mailboxes", { mode: "boolean" }).notNull().default(false),
+ keyboardShortcutsEnabled: integer("keyboard_shortcuts_enabled", { mode: "boolean" }).notNull().default(true),
createdByUserId: text("created_by_user_id").references((): AnySQLiteColumn => users.id, { onDelete: "set null" }),
createdAt: integer("created_at", { mode: "timestamp" })
.notNull()
diff --git a/src/lib/auth/types.d.ts b/src/lib/auth/types.d.ts
index ca28484..08842e7 100644
--- a/src/lib/auth/types.d.ts
+++ b/src/lib/auth/types.d.ts
@@ -10,6 +10,7 @@ export type SessionUser = {
role: UserRole;
disabled: boolean;
canManageMailboxes: boolean;
+ keyboardShortcutsEnabled: boolean;
createdByUserId: string | null;
createdAt: Date;
};
diff --git a/src/lib/setup/migration.ts b/src/lib/setup/migration.ts
index 7175b31..c1e8f3a 100644
--- a/src/lib/setup/migration.ts
+++ b/src/lib/setup/migration.ts
@@ -27,10 +27,11 @@ const MIGRATION_NAMES = [
"0025_add_threading_and_cc_bcc.sql",
"0026_add_contact_avatars.sql",
"0027_add_domain_sending_intent.sql",
+ "0028_add_keyboard_shortcuts_setting.sql",
];
const INITIAL_SCHEMA_SQL = `
-CREATE TABLE IF NOT EXISTS users (id text PRIMARY KEY NOT NULL, email text NOT NULL UNIQUE, reset_email text, forwarding_email text, password_hash text NOT NULL, name text NOT NULL, avatar_key text, role text DEFAULT 'user' NOT NULL, disabled integer DEFAULT false NOT NULL, can_manage_mailboxes integer DEFAULT false NOT NULL, created_by_user_id text REFERENCES users(id) ON DELETE set null, created_at integer NOT NULL);
+CREATE TABLE IF NOT EXISTS users (id text PRIMARY KEY NOT NULL, email text NOT NULL UNIQUE, reset_email text, forwarding_email text, password_hash text NOT NULL, name text NOT NULL, avatar_key text, role text DEFAULT 'user' NOT NULL, disabled integer DEFAULT false NOT NULL, can_manage_mailboxes integer DEFAULT false NOT NULL, keyboard_shortcuts_enabled integer DEFAULT true NOT NULL, created_by_user_id text REFERENCES users(id) ON DELETE set null, created_at integer NOT NULL);
CREATE INDEX IF NOT EXISTS users_created_by_idx ON users(created_by_user_id);
CREATE TABLE IF NOT EXISTS domains (id text PRIMARY KEY NOT NULL, user_id text NOT NULL REFERENCES users(id) ON DELETE cascade, hostname text NOT NULL, zone_id text NOT NULL, status text DEFAULT 'pending' NOT NULL, routing_status text, sending_subdomain_tag text, sending_requested integer DEFAULT false NOT NULL, sending_enabled integer DEFAULT false NOT NULL, routing_enabled integer DEFAULT false NOT NULL, created_at integer NOT NULL);
CREATE UNIQUE INDEX IF NOT EXISTS domains_hostname_idx ON domains(hostname);
diff --git a/src/lib/validators.ts b/src/lib/validators.ts
index 49f4cf6..9ebf1e3 100644
--- a/src/lib/validators.ts
+++ b/src/lib/validators.ts
@@ -189,6 +189,10 @@ export const updateForwardingEmailSchema = z.object({
),
});
+export const updateShortcutsSettingsSchema = z.object({
+ enabled: z.boolean(),
+});
+
export const changePasswordSchema = z.object({
currentPassword: z.string().min(1),
newPassword: z.string().min(8).max(128),