Files
ihasmail-inbuxa/web/src/lib/__tests__/keyboardFocus.test.ts
T
jcoffeyandJoe Esteves c118184975 Match Shift+letter shortcuts (Shift+I, Shift+U) (#399)
comboOf() let a shifted letter encode Shift in its case, so Shift+I
produced "I" and never matched the "shift+i" / "shift+u" bindings for
mark as read / unread. Shifted letters now yield "shift+<letter>";
symbols such as "#" and "!" still carry Shift in the character.

Fixes #398

Co-authored-by: Joe Esteves <[email protected]>
2026-09-18 08:22:13 -07:00

114 lines
3.8 KiB
TypeScript

import { afterEach, describe, expect, it, vi } from "vitest";
import { isTextEntry, keyboard } from "@/lib/input/keyboard";
/*
* Shortcuts after a click on a checkbox (#260).
*
* The guard that stops "a" archiving while you are typing into the search box
* tested `tagName === "INPUT"`, which is also true of a checkbox. A checkbox
* keeps focus after a click, so ticking "select all" disabled every shortcut
* until the reader clicked somewhere else — and nothing about a checkbox
* swallows a keystroke in the first place.
*/
const pressFrom = (el: EventTarget, key: string, init?: KeyboardEventInit) => {
const e = new KeyboardEvent("keydown", { key, bubbles: true, cancelable: true, ...init });
el.dispatchEvent(e);
return e;
};
let pop: (() => void) | null = null;
afterEach(() => {
pop?.();
pop = null;
document.body.innerHTML = "";
vi.restoreAllMocks();
});
describe("isTextEntry", () => {
const input = (type?: string) => {
const el = document.createElement("input");
if (type) el.setAttribute("type", type);
return el;
};
it("is false for the inputs you cannot type into", () => {
for (const type of ["checkbox", "radio", "button", "submit", "reset", "file", "color", "range"]) {
expect(isTextEntry(input(type)), type).toBe(false);
}
});
it("is true for the ones you can", () => {
for (const type of ["text", "search", "email", "url", "tel", "password", "number", "date", "time"]) {
expect(isTextEntry(input(type)), type).toBe(true);
}
});
it("treats an input with no type as text, which is what the browser does", () => {
expect(isTextEntry(input())).toBe(true);
});
it("covers textarea, select and contenteditable", () => {
expect(isTextEntry(document.createElement("textarea"))).toBe(true);
// A select takes letters too: typing jumps to the matching option, and a
// shortcut would steal that.
expect(isTextEntry(document.createElement("select"))).toBe(true);
const div = document.createElement("div");
div.contentEditable = "true";
Object.defineProperty(div, "isContentEditable", { value: true });
expect(isTextEntry(div)).toBe(true);
});
it("is false for a button and for nothing at all", () => {
expect(isTextEntry(document.createElement("button"))).toBe(false);
expect(isTextEntry(null)).toBe(false);
});
});
describe("shortcuts with a checkbox focused", () => {
it("still fire — the reported bug", () => {
const handler = vi.fn();
pop = keyboard.pushScope("test", [{ keys: "e", description: "Archive", group: "Mail", handler }]);
const box = document.createElement("input");
box.type = "checkbox";
document.body.appendChild(box);
box.focus();
pressFrom(box, "e");
expect(handler).toHaveBeenCalledTimes(1);
});
it("still do not fire from a text field", () => {
const handler = vi.fn();
pop = keyboard.pushScope("test", [{ keys: "e", description: "Archive", group: "Mail", handler }]);
const field = document.createElement("input");
field.type = "search";
document.body.appendChild(field);
field.focus();
pressFrom(field, "e");
expect(handler).not.toHaveBeenCalled();
});
});
describe("shifted letter shortcuts", () => {
it("matches Shift+I and Shift+U bindings", () => {
const read = vi.fn();
const unread = vi.fn();
pop = keyboard.pushScope("test", [
{ keys: "shift+i", description: "Mark as read", group: "Actions", handler: read },
{ keys: "shift+u", description: "Mark as unread", group: "Actions", handler: unread },
]);
const readEvent = pressFrom(window, "I", { shiftKey: true });
const unreadEvent = pressFrom(window, "U", { shiftKey: true });
expect(read).toHaveBeenCalledOnce();
expect(unread).toHaveBeenCalledOnce();
expect(readEvent.defaultPrevented).toBe(true);
expect(unreadEvent.defaultPrevented).toBe(true);
});
});