mirror of
https://github.com/element-hq/element-web.git
synced 2024-12-15 11:51:31 +03:00
173 lines
7 KiB
TypeScript
173 lines
7 KiB
TypeScript
/*
|
|
Copyright 2021 Clemens Zeidler
|
|
|
|
Licensed under the Apache License, Version 2.0 (the "License");
|
|
you may not use this file except in compliance with the License.
|
|
You may obtain a copy of the License at
|
|
|
|
http://www.apache.org/licenses/LICENSE-2.0
|
|
|
|
Unless required by applicable law or agreed to in writing, software
|
|
distributed under the License is distributed on an "AS IS" BASIS,
|
|
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
See the License for the specific language governing permissions and
|
|
limitations under the License.
|
|
*/
|
|
|
|
import { isKeyComboMatch, KeyCombo } from "../src/KeyBindingsManager";
|
|
|
|
function mockKeyEvent(
|
|
key: string,
|
|
modifiers?: {
|
|
ctrlKey?: boolean;
|
|
altKey?: boolean;
|
|
shiftKey?: boolean;
|
|
metaKey?: boolean;
|
|
},
|
|
): KeyboardEvent {
|
|
return {
|
|
key,
|
|
ctrlKey: modifiers?.ctrlKey ?? false,
|
|
altKey: modifiers?.altKey ?? false,
|
|
shiftKey: modifiers?.shiftKey ?? false,
|
|
metaKey: modifiers?.metaKey ?? false,
|
|
} as KeyboardEvent;
|
|
}
|
|
|
|
describe("KeyBindingsManager", () => {
|
|
it("should match basic key combo", () => {
|
|
const combo1: KeyCombo = {
|
|
key: "k",
|
|
};
|
|
expect(isKeyComboMatch(mockKeyEvent("k"), combo1, false)).toBe(true);
|
|
expect(isKeyComboMatch(mockKeyEvent("n"), combo1, false)).toBe(false);
|
|
});
|
|
|
|
it("should match key + modifier key combo", () => {
|
|
const combo: KeyCombo = {
|
|
key: "k",
|
|
ctrlKey: true,
|
|
};
|
|
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);
|
|
|
|
const combo2: KeyCombo = {
|
|
key: "k",
|
|
metaKey: true,
|
|
};
|
|
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);
|
|
|
|
const combo3: KeyCombo = {
|
|
key: "k",
|
|
altKey: true,
|
|
};
|
|
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);
|
|
|
|
const combo4: KeyCombo = {
|
|
key: "k",
|
|
shiftKey: true,
|
|
};
|
|
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);
|
|
});
|
|
|
|
it("should match key + multiple modifiers key combo", () => {
|
|
const combo: KeyCombo = {
|
|
key: "k",
|
|
ctrlKey: true,
|
|
altKey: true,
|
|
};
|
|
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,
|
|
);
|
|
|
|
const combo2: KeyCombo = {
|
|
key: "k",
|
|
ctrlKey: true,
|
|
shiftKey: true,
|
|
altKey: true,
|
|
};
|
|
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);
|
|
|
|
const combo3: KeyCombo = {
|
|
key: "k",
|
|
ctrlKey: true,
|
|
shiftKey: true,
|
|
altKey: true,
|
|
metaKey: true,
|
|
};
|
|
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,
|
|
);
|
|
});
|
|
|
|
it("should match ctrlOrMeta key combo", () => {
|
|
const combo: KeyCombo = {
|
|
key: "k",
|
|
ctrlOrCmdKey: true,
|
|
};
|
|
// PC:
|
|
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);
|
|
// MAC:
|
|
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);
|
|
});
|
|
|
|
it("should match advanced ctrlOrMeta key combo", () => {
|
|
const combo: KeyCombo = {
|
|
key: "k",
|
|
ctrlOrCmdKey: true,
|
|
altKey: true,
|
|
};
|
|
// PC:
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true, altKey: true }), combo, false)).toBe(true);
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { metaKey: true, altKey: true }), combo, false)).toBe(false);
|
|
// MAC:
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { metaKey: true, altKey: true }), combo, true)).toBe(true);
|
|
expect(isKeyComboMatch(mockKeyEvent("k", { ctrlKey: true, altKey: true }), combo, true)).toBe(false);
|
|
});
|
|
});
|