2021-03-07 09:05:36 +03:00
|
|
|
/*
|
2024-09-09 16:57:16 +03:00
|
|
|
Copyright 2024 New Vector Ltd.
|
2021-03-07 09:05:36 +03:00
|
|
|
Copyright 2021 Clemens Zeidler
|
|
|
|
|
2024-09-09 16:57:16 +03:00
|
|
|
SPDX-License-Identifier: AGPL-3.0-only OR GPL-3.0-only
|
|
|
|
Please see LICENSE files in the repository root for full details.
|
2021-03-07 09:05:36 +03:00
|
|
|
*/
|
|
|
|
|
2022-12-12 14:24:14 +03:00
|
|
|
import { isKeyComboMatch, KeyCombo } from "../src/KeyBindingsManager";
|
2021-02-11 12:18:10 +03:00
|
|
|
|
2022-12-12 14:24:14 +03:00
|
|
|
function mockKeyEvent(
|
|
|
|
key: string,
|
|
|
|
modifiers?: {
|
|
|
|
ctrlKey?: boolean;
|
|
|
|
altKey?: boolean;
|
|
|
|
shiftKey?: boolean;
|
|
|
|
metaKey?: boolean;
|
|
|
|
},
|
|
|
|
): KeyboardEvent {
|
2021-02-11 12:18:10 +03:00
|
|
|
return {
|
|
|
|
key,
|
|
|
|
ctrlKey: modifiers?.ctrlKey ?? false,
|
|
|
|
altKey: modifiers?.altKey ?? false,
|
|
|
|
shiftKey: modifiers?.shiftKey ?? false,
|
2021-06-04 18:52:50 +03:00
|
|
|
metaKey: modifiers?.metaKey ?? false,
|
2021-02-11 12:18:10 +03:00
|
|
|
} as KeyboardEvent;
|
|
|
|
}
|
|
|
|
|
2022-12-12 14:24:14 +03:00
|
|
|
describe("KeyBindingsManager", () => {
|
|
|
|
it("should match basic key combo", () => {
|
2021-02-11 12:18:10 +03:00
|
|
|
const combo1: KeyCombo = {
|
2022-12-12 14:24:14 +03:00
|
|
|
key: "k",
|
2021-02-11 12:18:10 +03:00
|
|
|
};
|
2022-12-12 14:24:14 +03:00
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k"), combo1, false)).toBe(true);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("n"), combo1, false)).toBe(false);
|
2021-02-11 12:18:10 +03:00
|
|
|
});
|
|
|
|
|
2022-12-12 14:24:14 +03:00
|
|
|
it("should match key + modifier key combo", () => {
|
2021-02-11 12:18:10 +03:00
|
|
|
const combo: KeyCombo = {
|
2022-12-12 14:24:14 +03:00
|
|
|
key: "k",
|
2021-02-11 12:18:10 +03:00
|
|
|
ctrlKey: true,
|
|
|
|
};
|
2022-12-12 14:24:14 +03:00
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true }), combo, false)).toBe(true);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("n", { ctrlKey: true }), combo, false)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k"), combo, false)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { shiftKey: true }), combo, false)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { shiftKey: true, metaKey: true }), combo, false)).toBe(false);
|
2021-02-11 12:18:10 +03:00
|
|
|
|
|
|
|
const combo2: KeyCombo = {
|
2022-12-12 14:24:14 +03:00
|
|
|
key: "k",
|
2021-02-11 12:18:10 +03:00
|
|
|
metaKey: true,
|
|
|
|
};
|
2022-12-12 14:24:14 +03:00
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { metaKey: true }), combo2, false)).toBe(true);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("n", { metaKey: true }), combo2, false)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k"), combo2, false)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { altKey: true, metaKey: true }), combo2, false)).toBe(false);
|
2021-02-11 12:18:10 +03:00
|
|
|
|
|
|
|
const combo3: KeyCombo = {
|
2022-12-12 14:24:14 +03:00
|
|
|
key: "k",
|
2021-02-11 12:18:10 +03:00
|
|
|
altKey: true,
|
|
|
|
};
|
2022-12-12 14:24:14 +03:00
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { altKey: true }), combo3, false)).toBe(true);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("n", { altKey: true }), combo3, false)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k"), combo3, false)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true, metaKey: true }), combo3, false)).toBe(false);
|
2021-02-11 12:18:10 +03:00
|
|
|
|
|
|
|
const combo4: KeyCombo = {
|
2022-12-12 14:24:14 +03:00
|
|
|
key: "k",
|
2021-02-11 12:18:10 +03:00
|
|
|
shiftKey: true,
|
|
|
|
};
|
2022-12-12 14:24:14 +03:00
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { shiftKey: true }), combo4, false)).toBe(true);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("n", { shiftKey: true }), combo4, false)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k"), combo4, false)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { shiftKey: true, ctrlKey: true }), combo4, false)).toBe(false);
|
2021-02-11 12:18:10 +03:00
|
|
|
});
|
|
|
|
|
2022-12-12 14:24:14 +03:00
|
|
|
it("should match key + multiple modifiers key combo", () => {
|
2021-02-11 12:18:10 +03:00
|
|
|
const combo: KeyCombo = {
|
2022-12-12 14:24:14 +03:00
|
|
|
key: "k",
|
2021-02-11 12:18:10 +03:00
|
|
|
ctrlKey: true,
|
|
|
|
altKey: true,
|
|
|
|
};
|
2022-12-12 14:24:14 +03:00
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true, altKey: true }), combo, false)).toBe(true);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("n", { ctrlKey: true, altKey: true }), combo, false)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true, metaKey: true }), combo, false)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true, metaKey: true, shiftKey: true }), combo, false)).toBe(
|
|
|
|
false,
|
|
|
|
);
|
2021-02-11 12:18:10 +03:00
|
|
|
|
|
|
|
const combo2: KeyCombo = {
|
2022-12-12 14:24:14 +03:00
|
|
|
key: "k",
|
2021-02-11 12:18:10 +03:00
|
|
|
ctrlKey: true,
|
|
|
|
shiftKey: true,
|
|
|
|
altKey: true,
|
|
|
|
};
|
2022-12-12 14:24:14 +03:00
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true, shiftKey: true, altKey: true }), combo2, false)).toBe(
|
|
|
|
true,
|
|
|
|
);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("n", { ctrlKey: true, shiftKey: true, altKey: true }), combo2, false)).toBe(
|
|
|
|
false,
|
|
|
|
);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true, metaKey: true }), combo2, false)).toBe(false);
|
|
|
|
expect(
|
|
|
|
isKeyComboMatch(
|
|
|
|
mockKeyEvent("k", { ctrlKey: true, shiftKey: true, altKey: true, metaKey: true }),
|
|
|
|
combo2,
|
|
|
|
false,
|
|
|
|
),
|
|
|
|
).toBe(false);
|
2021-02-11 12:18:10 +03:00
|
|
|
|
|
|
|
const combo3: KeyCombo = {
|
2022-12-12 14:24:14 +03:00
|
|
|
key: "k",
|
2021-02-11 12:18:10 +03:00
|
|
|
ctrlKey: true,
|
|
|
|
shiftKey: true,
|
|
|
|
altKey: true,
|
|
|
|
metaKey: true,
|
|
|
|
};
|
2022-12-12 14:24:14 +03:00
|
|
|
expect(
|
|
|
|
isKeyComboMatch(
|
|
|
|
mockKeyEvent("k", { ctrlKey: true, shiftKey: true, altKey: true, metaKey: true }),
|
|
|
|
combo3,
|
|
|
|
false,
|
|
|
|
),
|
|
|
|
).toBe(true);
|
|
|
|
expect(
|
|
|
|
isKeyComboMatch(
|
|
|
|
mockKeyEvent("n", { ctrlKey: true, shiftKey: true, altKey: true, metaKey: true }),
|
|
|
|
combo3,
|
|
|
|
false,
|
|
|
|
),
|
|
|
|
).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true, shiftKey: true, altKey: true }), combo3, false)).toBe(
|
|
|
|
false,
|
|
|
|
);
|
2021-02-11 12:18:10 +03:00
|
|
|
});
|
|
|
|
|
2022-12-12 14:24:14 +03:00
|
|
|
it("should match ctrlOrMeta key combo", () => {
|
2021-02-11 12:18:10 +03:00
|
|
|
const combo: KeyCombo = {
|
2022-12-12 14:24:14 +03:00
|
|
|
key: "k",
|
2022-01-31 18:55:45 +03:00
|
|
|
ctrlOrCmdKey: true,
|
2021-02-11 12:18:10 +03:00
|
|
|
};
|
|
|
|
// PC:
|
2022-12-12 14:24:14 +03:00
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true }), combo, false)).toBe(true);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { metaKey: true }), combo, false)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("n", { ctrlKey: true }), combo, false)).toBe(false);
|
2021-02-11 12:18:10 +03:00
|
|
|
// MAC:
|
2022-12-12 14:24:14 +03:00
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { metaKey: true }), combo, true)).toBe(true);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true }), combo, true)).toBe(false);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("n", { ctrlKey: true }), combo, true)).toBe(false);
|
2021-02-11 12:18:10 +03:00
|
|
|
});
|
|
|
|
|
2022-12-12 14:24:14 +03:00
|
|
|
it("should match advanced ctrlOrMeta key combo", () => {
|
2021-02-11 12:18:10 +03:00
|
|
|
const combo: KeyCombo = {
|
2022-12-12 14:24:14 +03:00
|
|
|
key: "k",
|
2022-01-31 18:55:45 +03:00
|
|
|
ctrlOrCmdKey: true,
|
2021-02-11 12:18:10 +03:00
|
|
|
altKey: true,
|
|
|
|
};
|
|
|
|
// PC:
|
2022-12-12 14:24:14 +03:00
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true, altKey: true }), combo, false)).toBe(true);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { metaKey: true, altKey: true }), combo, false)).toBe(false);
|
2021-02-11 12:18:10 +03:00
|
|
|
// MAC:
|
2022-12-12 14:24:14 +03:00
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { metaKey: true, altKey: true }), combo, true)).toBe(true);
|
|
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true, altKey: true }), combo, true)).toBe(false);
|
2021-02-11 12:18:10 +03:00
|
|
|
});
|
|
|
|
});
|