Skip to content

Email for professionals and teams

Give dialogs, menus and the composer proper focus handling (#92)

Can K.65df2554ecac
diff --git a/src/components/compose/compose-context.tsx b/src/components/compose/compose-context.tsx
index 3eb34ef..73dd074 100644
--- a/src/components/compose/compose-context.tsx
+++ b/src/components/compose/compose-context.tsx
@@ -1,6 +1,6 @@
"use client";
-import { createContext, useContext, useEffect, useState } from "react";
+import { createContext, useContext, useEffect, useRef, useState } from "react";
import type { ReactNode } from "react";
type ComposeContextValue = {
@@ -24,6 +24,11 @@ export function useCompose() {
export function ComposeProvider({ children }: { children: ReactNode }) {
const [open, setOpen] = useState(false);
const [draftId, setDraftId] = useState<string | null>(null);
+ const opener = useRef<HTMLElement | null>(null);
+
+ function rememberOpener() {
+ opener.current = document.activeElement instanceof HTMLElement ? document.activeElement : null;
+ }
const [notice, setNotice] = useState<string | null>(null);
useEffect(() => {
@@ -38,16 +43,21 @@ export function ComposeProvider({ children }: { children: ReactNode }) {
open,
draftId,
openComposer: () => {
+ rememberOpener();
setDraftId(null);
setOpen(true);
},
openDraftComposer: (nextDraftId) => {
+ if (!open) rememberOpener();
setDraftId(nextDraftId);
setOpen(true);
},
closeComposer: () => {
setOpen(false);
setDraftId(null);
+ const previous = opener.current;
+ opener.current = null;
+ if (previous) requestAnimationFrame(() => { if (previous.isConnected) previous.focus(); });
},
notice,
showNotice: setNotice,
diff --git a/src/components/compose/compose-form.tsx b/src/components/compose/compose-form.tsx
index d80e777..6f70e7e 100644
--- a/src/components/compose/compose-form.tsx
+++ b/src/components/compose/compose-form.tsx
@@ -76,6 +76,7 @@ export function ComposeForm({
const [loadedDraftMailboxId, setLoadedDraftMailboxId] = useState<string | null>(null);
const [loadedDraftFrom, setLoadedDraftFrom] = useState<string | null>(null);
const [selectedFrom, setSelectedFrom] = useState("");
+ const formRef = useRef<HTMLFormElement>(null);
const saveTimer = useRef<ReturnType<typeof setTimeout> | null>(null);
const pendingSave = useRef<(() => Promise<void>) | null>(null);
const draftGeneration = useRef(0);
@@ -251,6 +252,11 @@ export function ComposeForm({
};
}, [bcc, cc, draftId, fromAddr, html, loadingDraft, quotedHtml, selectedMailbox?.id, selectedMailbox?.signature, subject, threading, to]);
+ useEffect(() => {
+ if (!draftIdToLoad || loadingDraft) return;
+ formRef.current?.querySelector<HTMLElement>("[contenteditable='true']")?.focus();
+ }, [draftIdToLoad, loadingDraft]);
+
async function onSubmit(event: React.FormEvent<HTMLFormElement>) {
event.preventDefault();
if (to.length === 0) {
@@ -549,7 +555,7 @@ export function ComposeForm({
{toast.message}
</div>
)}
- <form onSubmit={onSubmit} className={frameClass} role={modalMode && !minimized ? "dialog" : undefined} aria-modal={modalMode && !minimized || undefined} aria-label={modalMode && !minimized ? t("compose.dialogLabel") : undefined} onKeyDown={(event) => { if (modalMode && !minimized && event.key === "Escape") { event.preventDefault(); setModalMode(false); } }} onDragEnterCapture={minimized ? undefined : onFileDragEnter} onDragOverCapture={minimized ? undefined : onFileDragOver} onDragLeaveCapture={minimized ? undefined : onFileDragLeave} onDropCapture={minimized ? undefined : onFileDrop}>
+ <form onSubmit={onSubmit} className={frameClass} ref={formRef} role={modalMode && !minimized ? "dialog" : mode === "popup" ? "region" : undefined} aria-modal={modalMode && !minimized || undefined} aria-label={mode === "popup" ? t("compose.dialogLabel") : undefined} onKeyDown={(event) => { if (modalMode && !minimized && event.key === "Escape") { event.preventDefault(); setModalMode(false); } }} onDragEnterCapture={minimized ? undefined : onFileDragEnter} onDragOverCapture={minimized ? undefined : onFileDragOver} onDragLeaveCapture={minimized ? undefined : onFileDragLeave} onDropCapture={minimized ? undefined : onFileDrop}>
{draggingFiles && !minimized && (
<div className="pointer-events-none absolute inset-0 z-30 flex items-center justify-center border-2 border-dashed border-blue-400 bg-blue-50/90 text-sm font-medium text-blue-700" aria-hidden="true">
{t("compose.dropFiles")}
@@ -609,6 +615,7 @@ export function ComposeForm({
onChange={setTo}
placeholder={t("compose.toPlaceholder")}
required
+ autoFocus={!draftIdToLoad}
disabled={loadingDraft}
trailing={
<>
diff --git a/src/components/mailbox-selector.tsx b/src/components/mailbox-selector.tsx
index ae1a619..fcea224 100644
--- a/src/components/mailbox-selector.tsx
+++ b/src/components/mailbox-selector.tsx
@@ -4,6 +4,7 @@ import Link from "next/link";
import { usePathname, useRouter } from "next/navigation";
import { CalendarDays, Check, HardDrive, ChevronDown, Inbox, LogOut, Settings, ShieldCheck, UserPlus, UserRound, UsersRound } from "lucide-react";
import { useEffect, useRef, useState } from "react";
+import { useDismissible } from "@/components/use-dismissible";
import { useLanguage } from "@/components/language-provider";
import { useSelectedMailbox } from "@/components/mailbox-provider";
import { ProgressiveAvatarImage } from "@/components/progressive-avatar-image";
@@ -142,14 +143,7 @@ export function MailboxSelector({ initialUser }: MailboxSelectorProps = {}) {
const ref = useRef<HTMLDivElement>(null);
const { counts } = useMessageCounts(null, open);
- useEffect(() => {
- function onPointerDown(event: PointerEvent) {
- if (!ref.current?.contains(event.target as Node)) setOpen(false);
- }
-
- document.addEventListener("pointerdown", onPointerDown);
- return () => document.removeEventListener("pointerdown", onPointerDown);
- }, []);
+ useDismissible(open, () => setOpen(false), ref);
useEffect(() => {
authFetch("/api/auth/me", { redirectOnUnauthorized: false })
diff --git a/src/components/message-actions/message-actions.tsx b/src/components/message-actions/message-actions.tsx
index dcbe813..81888f1 100644
--- a/src/components/message-actions/message-actions.tsx
+++ b/src/components/message-actions/message-actions.tsx
@@ -1,11 +1,12 @@
"use client";
-import { createElement, useState, useMemo, useCallback } from "react";
+import { createElement, useState, useMemo, useCallback, useRef } from "react";
import { useRouter } from "next/navigation";
import { Archive, Ban, BellOff, Clock, FileCode2, Forward, Mail, MailOpen, MoreVertical, Reply, ReplyAll, ShieldAlert, Trash2 } from "lucide-react";
import { useLanguage } from "@/components/language-provider";
import { useCompose } from "@/components/compose/compose-context";
import { MessageSourceDialog } from "@/components/messages/message-source-dialog";
+import { useDismissible } from "@/components/use-dismissible";
import { useMessageListVisibility } from "@/components/messages/message-list-visibility";
import { MessageSnoozeDialog } from "./message-snooze-dialog";
import { useIsMobile } from "@/components/sidebar-mobile-utils";
@@ -58,6 +59,8 @@ export function MessageActions({
>(null);
const [error, setError] = useState<string | null>(null);
const [moreOpen, setMoreOpen] = useState(false);
+ const moreRef = useRef<HTMLDivElement>(null);
+ useDismissible(moreOpen, () => setMoreOpen(false), moreRef);
const [sourceOpen, setSourceOpen] = useState(false);
const [snoozeOpen, setSnoozeOpen] = useState(false);
@@ -381,7 +384,7 @@ export function MessageActions({
</Tooltip>
</>
)}
- <div className="relative">
+ <div ref={moreRef} className="relative">
<Tooltip label={t("common.moreActions")}>
<Button
type="button"
diff --git a/src/components/messages/thread-message-actions.tsx b/src/components/messages/thread-message-actions.tsx
index 772240f..6dbec80 100644
--- a/src/components/messages/thread-message-actions.tsx
+++ b/src/components/messages/thread-message-actions.tsx
@@ -1,9 +1,10 @@
"use client";
-import { createElement, useEffect, useState } from "react";
+import { createElement, useEffect, useRef, useState } from "react";
import { Ban, FileCode2, Forward, Mail, MailOpen, MoreVertical, Reply, ReplyAll, Star } from "lucide-react";
import { useCompose } from "@/components/compose/compose-context";
import { MessageSourceDialog } from "@/components/messages/message-source-dialog";
+import { useDismissible } from "@/components/use-dismissible";
import { getOwnAddressForMessage } from "@/app/(dashboard)/inbox/[messageId]/utils";
import { useLanguage } from "@/components/language-provider";
import { Button } from "@/components/ui/button";
@@ -33,6 +34,8 @@ export function ThreadMessageActions({
const { openDraftComposer } = useCompose();
const [starred, setStarred] = useState(message.starred);
const [moreOpen, setMoreOpen] = useState(false);
+ const moreRef = useRef<HTMLDivElement>(null);
+ useDismissible(moreOpen, () => setMoreOpen(false), moreRef);
const [sourceOpen, setSourceOpen] = useState(false);
const [pending, setPending] = useState(false);
const [error, setError] = useState<string | null>(null);
@@ -163,7 +166,7 @@ export function ThreadMessageActions({
<Reply className="h-4 w-4" />
</Button>
</Tooltip>
- <div className="relative">
+ <div ref={moreRef} className="relative">
<Tooltip label={t("common.moreActions")}>
<Button
type="button"
diff --git a/src/components/shortcuts/command-palette-item.tsx b/src/components/shortcuts/command-palette-item.tsx
index 7b950ef..71b324c 100644
--- a/src/components/shortcuts/command-palette-item.tsx
+++ b/src/components/shortcuts/command-palette-item.tsx
@@ -4,6 +4,7 @@ import React from "react";
import type { CommandItem } from "./types";
interface CommandPaletteItemProps {
+ id: string;
item: CommandItem;
isActive: boolean;
onSelect: () => void;
@@ -11,6 +12,7 @@ interface CommandPaletteItemProps {
}
export function CommandPaletteItem({
+ id,
item,
isActive,
onSelect,
@@ -20,7 +22,11 @@ export function CommandPaletteItem({
return (
<button
+ id={id}
type="button"
+ role="option"
+ aria-selected={isActive}
+ tabIndex={-1}
onClick={onSelect}
onMouseEnter={onHover}
className={`w-full text-left px-3 py-2.5 rounded-xl flex items-center justify-between transition-colors ${
diff --git a/src/components/shortcuts/command-palette.tsx b/src/components/shortcuts/command-palette.tsx
index 670a9f6..c9608ad 100644
--- a/src/components/shortcuts/command-palette.tsx
+++ b/src/components/shortcuts/command-palette.tsx
@@ -1,12 +1,13 @@
"use client";
-import React, { useState, useEffect, useRef, useMemo } from "react";
+import React, { useId, useState, useEffect, useRef, useMemo } from "react";
import { Search, CornerDownLeft } from "lucide-react";
import { useLanguage } from "@/components/language-provider";
import type { CommandItem } from "./types";
import type { TranslationKey } from "@/lib/i18n/types";
import { filterCommands, groupCommandsByCategory } from "./command-palette-utils";
import { CommandPaletteItem } from "./command-palette-item";
+import { useDialogFocus } from "@/components/use-dialog-focus";
interface CommandPaletteProps {
isOpen: boolean;
@@ -25,10 +26,9 @@ function CommandPaletteDialog({
const [query, setQuery] = useState("");
const [selectedIndex, setSelectedIndex] = useState(0);
const inputRef = useRef<HTMLInputElement>(null);
-
- useEffect(() => {
- inputRef.current?.focus();
- }, []);
+ const dialogRef = useRef<HTMLDivElement>(null);
+ const listboxId = useId();
+ useDialogFocus(dialogRef, inputRef);
const filteredCommands = useMemo(
() => filterCommands(commands, query),
@@ -67,11 +67,20 @@ function CommandPaletteDialog({
);
let flatIndex = 0;
+ const optionId = (index: number) => `${listboxId}-option-${index}`;
+
+ useEffect(() => {
+ document.getElementById(`${listboxId}-option-${activeIndex}`)?.scrollIntoView({ block: "nearest" });
+ }, [activeIndex, listboxId]);
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
+ ref={dialogRef}
+ role="dialog"
+ aria-modal="true"
+ aria-label={t("palette.placeholder")}
className="relative w-full max-w-xl bg-white border border-neutral-200 rounded-2xl shadow-2xl overflow-hidden flex flex-col z-10"
onKeyDown={handleKeyDown}
>
@@ -87,6 +96,12 @@ function CommandPaletteDialog({
setSelectedIndex(0);
}}
placeholder={t("palette.placeholder")}
+ role="combobox"
+ aria-expanded="true"
+ aria-controls={listboxId}
+ aria-autocomplete="list"
+ aria-activedescendant={filteredCommands.length ? optionId(activeIndex) : undefined}
+ aria-label={t("palette.placeholder")}
className="w-full bg-transparent text-neutral-900 placeholder-neutral-400 text-[15px] focus:outline-none"
/>
<kbd className="px-2 py-0.5 text-xs font-semibold text-neutral-400 bg-neutral-100 border border-neutral-200 rounded-md shadow-2xs">
@@ -95,15 +110,15 @@ function CommandPaletteDialog({
</div>
{/* Results */}
- <div className="max-h-80 overflow-y-auto p-2">
+ <div id={listboxId} role="listbox" aria-label={t("palette.placeholder")} className="max-h-80 overflow-y-auto p-2">
{filteredCommands.length === 0 ? (
- <div className="p-8 text-center text-sm text-neutral-400">
+ <div role="status" className="p-8 text-center text-sm text-neutral-400">
{t("palette.noMatch", { query })}
</div>
) : (
Object.entries(grouped).map(([category, items]) => (
- <div key={category} className="mb-2 last:mb-0">
- <div className="px-3 py-1 text-[11px] font-semibold uppercase tracking-wider text-neutral-400">
+ <div key={category} role="group" aria-label={t(`shortcut.category.${category}` as TranslationKey)} className="mb-2 last:mb-0">
+ <div aria-hidden="true" className="px-3 py-1 text-[11px] font-semibold uppercase tracking-wider text-neutral-400">
{t(`shortcut.category.${category}` as TranslationKey)}
</div>
{items.map((item) => {
@@ -114,6 +129,7 @@ function CommandPaletteDialog({
return (
<CommandPaletteItem
key={item.id}
+ id={optionId(itemIndex)}
item={item}
isActive={isCurrent}
onSelect={() => {
diff --git a/src/components/shortcuts/shortcuts-help-dialog.tsx b/src/components/shortcuts/shortcuts-help-dialog.tsx
index dee8dec..f75ff3e 100644
--- a/src/components/shortcuts/shortcuts-help-dialog.tsx
+++ b/src/components/shortcuts/shortcuts-help-dialog.tsx
@@ -1,10 +1,11 @@
"use client";
-import React from "react";
+import React, { useId, useRef } from "react";
import { X, Keyboard } from "lucide-react";
import { useLanguage } from "@/components/language-provider";
import type { TranslationKey } from "@/lib/i18n/types";
import type { ShortcutDefinition } from "./types";
+import { useDialogFocus } from "@/components/use-dialog-focus";
interface ShortcutsHelpDialogProps {
isOpen: boolean;
@@ -24,13 +25,20 @@ function withKey(text: string, key: string) {
);
}
-export function ShortcutsHelpDialog({
- isOpen,
+export function ShortcutsHelpDialog({ isOpen, onClose, shortcuts }: ShortcutsHelpDialogProps) {
+ if (!isOpen) return null;
+ return <ShortcutsHelpDialogContent onClose={onClose} shortcuts={shortcuts} />;
+}
+
+function ShortcutsHelpDialogContent({
onClose,
shortcuts,
-}: ShortcutsHelpDialogProps) {
+}: Omit<ShortcutsHelpDialogProps, "isOpen">) {
const { t } = useLanguage();
- if (!isOpen) return null;
+ const dialogRef = useRef<HTMLDivElement>(null);
+ const closeRef = useRef<HTMLButtonElement>(null);
+ const titleId = useId();
+ useDialogFocus(dialogRef, closeRef);
const grouped = shortcuts.reduce((acc, item) => {
if (!acc[item.category]) acc[item.category] = [];
@@ -59,7 +67,18 @@ export function ShortcutsHelpDialog({
onClick={onClose}
aria-hidden="true"
/>
- <div className="relative w-full max-w-2xl bg-white border border-neutral-200 rounded-2xl shadow-2xl overflow-hidden flex flex-col z-10 max-h-[85vh]">
+ <div
+ ref={dialogRef}
+ role="dialog"
+ aria-modal="true"
+ aria-labelledby={titleId}
+ onKeyDown={(event) => {
+ if (event.key !== "Escape" && event.key !== "?") return;
+ event.stopPropagation();
+ onClose();
+ }}
+ className="relative w-full max-w-2xl bg-white border border-neutral-200 rounded-2xl shadow-2xl overflow-hidden flex flex-col z-10 max-h-[85vh]"
+ >
{/* Header */}
<div className="flex items-center justify-between px-6 py-4 border-b border-neutral-100">
<div className="flex items-center gap-2.5">
@@ -67,7 +86,7 @@ export function ShortcutsHelpDialog({
<Keyboard className="w-5 h-5" />
</div>
<div>
- <h2 className="text-base font-semibold text-neutral-900">
+ <h2 id={titleId} className="text-base font-semibold text-neutral-900">
{t("shortcutsHelp.title")}
</h2>
<p className="text-xs text-neutral-400">
@@ -76,6 +95,7 @@ export function ShortcutsHelpDialog({
</div>
</div>
<button
+ ref={closeRef}
type="button"
onClick={onClose}
aria-label={t("shortcutsHelp.close")}
diff --git a/src/components/shortcuts/use-hotkeys.ts b/src/components/shortcuts/use-hotkeys.ts
index 1264df9..db4d693 100644
--- a/src/components/shortcuts/use-hotkeys.ts
+++ b/src/components/shortcuts/use-hotkeys.ts
@@ -95,6 +95,8 @@ export function useHotkeys(
if (isModifierKey(key)) return;
+ if (e.target instanceof Element && e.target.closest('[role="dialog"], [role="menu"], [role="listbox"]')) return;
+
// Handle sequence buffer
sequenceBufferRef.current.push(key);
diff --git a/src/components/ui/tooltip.tsx b/src/components/ui/tooltip.tsx
index 5eb50a5..1849c94 100644
--- a/src/components/ui/tooltip.tsx
+++ b/src/components/ui/tooltip.tsx
@@ -1,7 +1,7 @@
"use client";
import { cn } from "@/lib/utils";
-import { useLayoutEffect, useRef, useState } from "react";
+import { useEffect, useLayoutEffect, useRef, useState } from "react";
import { createPortal } from "react-dom";
import type { TooltipPosition, TooltipProps } from "./tooltip-types";
import { getTooltipPosition } from "./tooltip-utils";
@@ -12,6 +12,15 @@ export function Tooltip({ label, children, className, placement = "auto" }: Tool
const triggerRef = useRef<HTMLSpanElement>(null);
const tooltipRef = useRef<HTMLSpanElement>(null);
+ useEffect(() => {
+ if (!open) return;
+ function onKeyDown(event: KeyboardEvent) {
+ if (event.key === "Escape") setOpen(false);
+ }
+ document.addEventListener("keydown", onKeyDown);
+ return () => document.removeEventListener("keydown", onKeyDown);
+ }, [open]);
+
useLayoutEffect(() => {
if (!open) return;
@@ -40,10 +49,7 @@ export function Tooltip({ label, children, className, placement = "auto" }: Tool
onBlurCapture={() => setOpen(false)}
onMouseEnter={() => setOpen(true)}
onMouseLeave={() => setOpen(false)}
- onClickCapture={() => {
- setOpen(false);
- if (document.activeElement instanceof HTMLElement) document.activeElement.blur();
- }}
+ onClickCapture={() => setOpen(false)}
>
{children}
{open && typeof document !== "undefined" &&
diff --git a/src/components/use-dialog-focus.ts b/src/components/use-dialog-focus.ts
new file mode 100644
index 0000000..77f1ad0
--- /dev/null
+++ b/src/components/use-dialog-focus.ts
@@ -0,0 +1,49 @@
+"use client";
+
+import { useEffect, useState } from "react";
+import type { RefObject } from "react";
+
+const FOCUSABLE = ["a[href]", "button:not([disabled])", "input:not([disabled])", "select:not([disabled])", "textarea:not([disabled])", "[tabindex]"]
+ .map((selector) => `${selector}:not([tabindex="-1"])`)
+ .join(", ");
+
+export function getFocusable(container: HTMLElement): HTMLElement[] {
+ return [...container.querySelectorAll<HTMLElement>(FOCUSABLE)].filter((element) => element.offsetParent !== null || element === document.activeElement);
+}
+
+export function useDialogFocus(container: RefObject<HTMLElement | null>, initialFocus?: RefObject<HTMLElement | null>) {
+ const [opener] = useState(() => (typeof document !== "undefined" && document.activeElement instanceof HTMLElement ? document.activeElement : null));
+
+ useEffect(() => {
+ const root = container.current;
+ (initialFocus?.current ?? (root ? getFocusable(root)[0] : null) ?? root)?.focus();
+
+ function onKeyDown(event: KeyboardEvent) {
+ if (event.key !== "Tab" || !root) return;
+ const focusable = getFocusable(root);
+ if (focusable.length === 0) {
+ event.preventDefault();
+ return;
+ }
+ const first = focusable[0];
+ const last = focusable[focusable.length - 1];
+ const inside = root.contains(document.activeElement);
+ if (event.shiftKey && (!inside || document.activeElement === first)) {
+ event.preventDefault();
+ last.focus();
+ } else if (!event.shiftKey && (!inside || document.activeElement === last)) {
+ event.preventDefault();
+ first.focus();
+ }
+ }
+
+ document.addEventListener("keydown", onKeyDown);
+ return () => {
+ document.removeEventListener("keydown", onKeyDown);
+ };
+ }, [container, initialFocus]);
+
+ useEffect(() => () => {
+ if (opener?.isConnected) opener.focus();
+ }, [opener]);
+}
diff --git a/src/components/use-dismissible.ts b/src/components/use-dismissible.ts
new file mode 100644
index 0000000..8195053
--- /dev/null
+++ b/src/components/use-dismissible.ts
@@ -0,0 +1,35 @@
+"use client";
+
+import { useEffect, useRef } from "react";
+import type { RefObject } from "react";
+
+export function useDismissible(open: boolean, onClose: () => void, container: RefObject<HTMLElement | null>) {
+ const close = useRef(onClose);
+ close.current = onClose;
+
+ useEffect(() => {
+ if (!open) return;
+
+ function onKeyDown(event: KeyboardEvent) {
+ if (event.key !== "Escape") return;
+ event.stopPropagation();
+ close.current();
+ container.current?.querySelector<HTMLElement>("[aria-expanded]")?.focus();
+ }
+ function onPointerDown(event: PointerEvent) {
+ if (!container.current?.contains(event.target as Node)) close.current();
+ }
+ function onFocusIn(event: FocusEvent) {
+ if (!container.current?.contains(event.target as Node)) close.current();
+ }
+
+ document.addEventListener("keydown", onKeyDown);
+ document.addEventListener("pointerdown", onPointerDown);
+ document.addEventListener("focusin", onFocusIn);
+ return () => {
+ document.removeEventListener("keydown", onKeyDown);
+ document.removeEventListener("pointerdown", onPointerDown);
+ document.removeEventListener("focusin", onFocusIn);
+ };
+ }, [open, container]);
+}