Skip to content

Build your personal knowledge base with Trilium Notes

3.9 KB
Raw Blame
import { describe, expect, it } from "vitest";

import { claimsKeystroke, codeToControl, getPanDelta } from "./zoom_pan_keyboard";

describe("codeToControl", () => {
    it("maps zoom/reset keys (Equal/Minus/Slash, numpad, Q/E) regardless of modifiers", () => {
        expect(codeToControl("Equal")).toBe("zoomIn");
        expect(codeToControl("NumpadAdd")).toBe("zoomIn");
        expect(codeToControl("KeyE")).toBe("zoomIn");
        expect(codeToControl("Minus")).toBe("zoomOut");
        expect(codeToControl("NumpadSubtract")).toBe("zoomOut");
        expect(codeToControl("KeyQ")).toBe("zoomOut");
        expect(codeToControl("Slash")).toBe("reset");
        expect(codeToControl("NumpadDivide")).toBe("reset");
    });

    it("maps arrows and WASD to pan controls", () => {
        expect(codeToControl("ArrowUp")).toBe("panUp");
        expect(codeToControl("KeyW")).toBe("panUp");
        expect(codeToControl("ArrowDown")).toBe("panDown");
        expect(codeToControl("KeyS")).toBe("panDown");
        expect(codeToControl("ArrowLeft")).toBe("panLeft");
        expect(codeToControl("KeyA")).toBe("panLeft");
        expect(codeToControl("ArrowRight")).toBe("panRight");
        expect(codeToControl("KeyD")).toBe("panRight");
    });

    it("ignores unrelated keys", () => {
        expect(codeToControl("KeyZ")).toBeNull();
        expect(codeToControl("Space")).toBeNull();
    });
});

describe("claimsKeystroke", () => {
    const keystroke = (code: string, modifiers: Partial<{ ctrlKey: boolean; metaKey: boolean; altKey: boolean }> = {}) =>
        ({ code, ctrlKey: false, metaKey: false, altKey: false, ...modifiers });

    it("takes bare keys, which are the viewer's own", () => {
        expect(claimsKeystroke(keystroke("KeyW"))).toBe(true);
        expect(claimsKeystroke(keystroke("ArrowLeft"))).toBe(true);
        expect(claimsKeystroke(keystroke("Equal"))).toBe(true);
    });

    it("leaves chords to the application, so Ctrl+W still closes the tab", () => {
        expect(claimsKeystroke(keystroke("KeyW", { ctrlKey: true }))).toBe(false);
        expect(claimsKeystroke(keystroke("ArrowUp", { ctrlKey: true }))).toBe(false);
        expect(claimsKeystroke(keystroke("Slash", { altKey: true }))).toBe(false);
        // The letter aliases for zoom are ordinary letters as far as the app is concerned (Ctrl+Q quits).
        expect(claimsKeystroke(keystroke("KeyE", { ctrlKey: true }))).toBe(false);
        expect(claimsKeystroke(keystroke("KeyQ", { ctrlKey: true }))).toBe(false);
    });

    it("keeps the zoom gesture, where the modifier is the point", () => {
        // Looking at an image, Ctrl+= zooms the image rather than the whole UI.
        expect(claimsKeystroke(keystroke("Equal", { ctrlKey: true }))).toBe(true);
        expect(claimsKeystroke(keystroke("Minus", { metaKey: true }))).toBe(true);
        expect(claimsKeystroke(keystroke("NumpadAdd", { ctrlKey: true }))).toBe(true);
        expect(claimsKeystroke(keystroke("NumpadSubtract", { ctrlKey: true }))).toBe(true);
    });
});

describe("getPanDelta", () => {
    it("translates the content opposite the viewed direction", () => {
        expect(getPanDelta([ "panRight" ], false, 1).dx).toBeLessThan(0);
        expect(getPanDelta([ "panLeft" ], false, 1).dx).toBeGreaterThan(0);
        expect(getPanDelta([ "panUp" ], false, 1).dy).toBeGreaterThan(0);
        expect(getPanDelta([ "panDown" ], false, 1).dy).toBeLessThan(0);
    });

    it("cancels opposing keys and scales by elapsed time", () => {
        expect(getPanDelta([ "panLeft", "panRight" ], false, 1)).toEqual({ dx: 0, dy: 0 });
        const slow = getPanDelta([ "panRight" ], false, 0.5).dx;
        const fast = getPanDelta([ "panRight" ], false, 1).dx;
        expect(fast).toBe(slow * 2);
    });

    it("speeds up while Shift is held", () => {
        const normal = Math.abs(getPanDelta([ "panRight" ], false, 1).dx);
        const fast = Math.abs(getPanDelta([ "panRight" ], true, 1).dx);
        expect(fast).toBeGreaterThan(normal);
    });
});