Improve the look of the keyboard settings tab (#7562)
* First cut of new keyboard shortcuts Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com> * Remove unused code Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com> * i18n Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com> * Amend shortcuts Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com> * Improve CATEGORIES struct Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com> * Add tests for registerShortcut() Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com> * Simplifie code tiny bit Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com> * Translate ALTERNATE_KEY_NAME Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com> * Fix `key` usage Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com> * Export components for tests Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com> * Write snapshot tests Signed-off-by: Šimon Brandner <simon.bra.ag@gmail.com>
This commit is contained in:
Šimon Brandner
GitHub
parent
55ec1bdc85
commit
5f18e4888c
7 changed files with 932 additions and 383 deletions
|
|
@ -0,0 +1,134 @@
|
|||
|
||||
/*
|
||||
Copyright 2022 Šimon Brandner <simon.bra.ag@gmail.com>
|
||||
|
||||
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 React from "react";
|
||||
import { mount, ReactWrapper } from "enzyme";
|
||||
|
||||
import { Key } from "../../../../../../src/Keyboard";
|
||||
|
||||
const PATH_TO_KEYBOARD_SHORTCUTS = "../../../../../../src/accessibility/KeyboardShortcuts";
|
||||
const PATH_TO_COMPONENT = "../../../../../../src/components/views/settings/tabs/user/KeyboardUserSettingsTab";
|
||||
|
||||
const mockKeyboardShortcuts = (override) => {
|
||||
jest.doMock(PATH_TO_KEYBOARD_SHORTCUTS, () => {
|
||||
const original = jest.requireActual(PATH_TO_KEYBOARD_SHORTCUTS);
|
||||
return {
|
||||
...original,
|
||||
...override,
|
||||
};
|
||||
});
|
||||
};
|
||||
|
||||
const renderKeyboardUserSettingsTab = async (component, props?): Promise<ReactWrapper> => {
|
||||
const Component = (await import(PATH_TO_COMPONENT))[component];
|
||||
return mount(<Component {...props} />);
|
||||
};
|
||||
|
||||
describe("KeyboardUserSettingsTab", () => {
|
||||
beforeEach(() => {
|
||||
jest.resetModules();
|
||||
});
|
||||
|
||||
it("renders key icon", async () => {
|
||||
const body = await renderKeyboardUserSettingsTab("KeyboardKey", { name: Key.ARROW_DOWN });
|
||||
expect(body).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it("renders alternative key name", async () => {
|
||||
const body = await renderKeyboardUserSettingsTab("KeyboardKey", { name: Key.PAGE_DOWN });
|
||||
expect(body).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it("doesn't render + if last", async () => {
|
||||
const body = await renderKeyboardUserSettingsTab("KeyboardKey", { name: Key.A, last: true });
|
||||
expect(body).toMatchSnapshot();
|
||||
});
|
||||
|
||||
it("doesn't render same modifier twice", async () => {
|
||||
mockKeyboardShortcuts({
|
||||
"KEYBOARD_SHORTCUTS": {
|
||||
"keybind1": {
|
||||
default: {
|
||||
key: Key.A,
|
||||
ctrlOrCmdKey: true,
|
||||
metaKey: true,
|
||||
},
|
||||
displayName: "Cancel replying to a message",
|
||||
},
|
||||
},
|
||||
});
|
||||
const body1 = await renderKeyboardUserSettingsTab("KeyboardShortcut", { name: "keybind1" });
|
||||
expect(body1).toMatchSnapshot();
|
||||
jest.resetModules();
|
||||
|
||||
mockKeyboardShortcuts({
|
||||
"KEYBOARD_SHORTCUTS": {
|
||||
"keybind1": {
|
||||
default: {
|
||||
key: Key.A,
|
||||
ctrlOrCmdKey: true,
|
||||
ctrlKey: true,
|
||||
},
|
||||
displayName: "Cancel replying to a message",
|
||||
},
|
||||
},
|
||||
});
|
||||
const body2 = await renderKeyboardUserSettingsTab("KeyboardShortcut", { name: "keybind1" });
|
||||
expect(body2).toMatchSnapshot();
|
||||
jest.resetModules();
|
||||
});
|
||||
|
||||
it("renders list of keyboard shortcuts", async () => {
|
||||
mockKeyboardShortcuts({
|
||||
"KEYBOARD_SHORTCUTS": {
|
||||
"keybind1": {
|
||||
default: {
|
||||
key: Key.A,
|
||||
ctrlKey: true,
|
||||
},
|
||||
displayName: "Cancel replying to a message",
|
||||
},
|
||||
"keybind2": {
|
||||
default: {
|
||||
key: Key.B,
|
||||
ctrlKey: true,
|
||||
},
|
||||
displayName: "Toggle Bold",
|
||||
},
|
||||
"keybind3": {
|
||||
default: {
|
||||
key: Key.ENTER,
|
||||
},
|
||||
displayName: "Select room from the room list",
|
||||
},
|
||||
},
|
||||
"CATEGORIES": {
|
||||
"Composer": {
|
||||
settingNames: ["keybind1", "keybind2"],
|
||||
categoryLabel: "Composer",
|
||||
},
|
||||
"Navigation": {
|
||||
settingNames: ["keybind3"],
|
||||
categoryLabel: "Navigation",
|
||||
},
|
||||
},
|
||||
});
|
||||
|
||||
const body = await renderKeyboardUserSettingsTab("default");
|
||||
expect(body).toMatchSnapshot();
|
||||
});
|
||||
});
|
||||
|
|
@ -0,0 +1,269 @@
|
|||
// Jest Snapshot v1, https://goo.gl/fbAQLP
|
||||
|
||||
exports[`KeyboardUserSettingsTab doesn't render + if last 1`] = `
|
||||
<KeyboardKey
|
||||
last={true}
|
||||
name="a"
|
||||
>
|
||||
<kbd>
|
||||
|
||||
a
|
||||
|
||||
</kbd>
|
||||
</KeyboardKey>
|
||||
`;
|
||||
|
||||
exports[`KeyboardUserSettingsTab doesn't render same modifier twice 1`] = `
|
||||
<KeyboardShortcut
|
||||
name="keybind1"
|
||||
>
|
||||
<div>
|
||||
<KeyboardKey
|
||||
key="ctrlOrCmdKey"
|
||||
name="Control"
|
||||
>
|
||||
<kbd>
|
||||
|
||||
missing translation: en|Ctrl
|
||||
|
||||
</kbd>
|
||||
+
|
||||
</KeyboardKey>
|
||||
<KeyboardKey
|
||||
last={true}
|
||||
name="a"
|
||||
>
|
||||
<kbd>
|
||||
|
||||
a
|
||||
|
||||
</kbd>
|
||||
</KeyboardKey>
|
||||
</div>
|
||||
</KeyboardShortcut>
|
||||
`;
|
||||
|
||||
exports[`KeyboardUserSettingsTab doesn't render same modifier twice 2`] = `
|
||||
<KeyboardShortcut
|
||||
name="keybind1"
|
||||
>
|
||||
<div>
|
||||
<KeyboardKey
|
||||
key="ctrlOrCmdKey"
|
||||
name="Control"
|
||||
>
|
||||
<kbd>
|
||||
|
||||
missing translation: en|Ctrl
|
||||
|
||||
</kbd>
|
||||
+
|
||||
</KeyboardKey>
|
||||
<KeyboardKey
|
||||
last={true}
|
||||
name="a"
|
||||
>
|
||||
<kbd>
|
||||
|
||||
a
|
||||
|
||||
</kbd>
|
||||
</KeyboardKey>
|
||||
</div>
|
||||
</KeyboardShortcut>
|
||||
`;
|
||||
|
||||
exports[`KeyboardUserSettingsTab renders alternative key name 1`] = `
|
||||
<KeyboardKey
|
||||
name="PageDown"
|
||||
>
|
||||
<kbd>
|
||||
|
||||
missing translation: en|Page Down
|
||||
|
||||
</kbd>
|
||||
+
|
||||
</KeyboardKey>
|
||||
`;
|
||||
|
||||
exports[`KeyboardUserSettingsTab renders key icon 1`] = `
|
||||
<KeyboardKey
|
||||
name="ArrowDown"
|
||||
>
|
||||
<kbd>
|
||||
|
||||
↓
|
||||
|
||||
</kbd>
|
||||
+
|
||||
</KeyboardKey>
|
||||
`;
|
||||
|
||||
exports[`KeyboardUserSettingsTab renders list of keyboard shortcuts 1`] = `
|
||||
<KeyboardUserSettingsTab>
|
||||
<div
|
||||
className="mx_SettingsTab mx_KeyboardUserSettingsTab"
|
||||
>
|
||||
<div
|
||||
className="mx_SettingsTab_heading"
|
||||
>
|
||||
missing translation: en|Keyboard
|
||||
</div>
|
||||
<KeyboardShortcutSection
|
||||
category={
|
||||
Object {
|
||||
"categoryLabel": "Composer",
|
||||
"settingNames": Array [
|
||||
"keybind1",
|
||||
"keybind2",
|
||||
],
|
||||
}
|
||||
}
|
||||
categoryName="Composer"
|
||||
key="Composer"
|
||||
>
|
||||
<div
|
||||
className="mx_SettingsTab_section"
|
||||
key="Composer"
|
||||
>
|
||||
<div
|
||||
className="mx_SettingsTab_subheading"
|
||||
>
|
||||
missing translation: en|Composer
|
||||
</div>
|
||||
<div>
|
||||
|
||||
<KeyboardShortcutRow
|
||||
key="keybind1"
|
||||
name="keybind1"
|
||||
>
|
||||
<div
|
||||
className="mx_KeyboardShortcut_shortcutRow"
|
||||
>
|
||||
Cancel replying to a message
|
||||
<KeyboardShortcut
|
||||
name="keybind1"
|
||||
>
|
||||
<div>
|
||||
<KeyboardKey
|
||||
key="ctrlKey"
|
||||
name="Control"
|
||||
>
|
||||
<kbd>
|
||||
|
||||
missing translation: en|Ctrl
|
||||
|
||||
</kbd>
|
||||
+
|
||||
</KeyboardKey>
|
||||
<KeyboardKey
|
||||
last={true}
|
||||
name="a"
|
||||
>
|
||||
<kbd>
|
||||
|
||||
a
|
||||
|
||||
</kbd>
|
||||
</KeyboardKey>
|
||||
</div>
|
||||
</KeyboardShortcut>
|
||||
</div>
|
||||
</KeyboardShortcutRow>
|
||||
<KeyboardShortcutRow
|
||||
key="keybind2"
|
||||
name="keybind2"
|
||||
>
|
||||
<div
|
||||
className="mx_KeyboardShortcut_shortcutRow"
|
||||
>
|
||||
Toggle Bold
|
||||
<KeyboardShortcut
|
||||
name="keybind2"
|
||||
>
|
||||
<div>
|
||||
<KeyboardKey
|
||||
key="ctrlKey"
|
||||
name="Control"
|
||||
>
|
||||
<kbd>
|
||||
|
||||
missing translation: en|Ctrl
|
||||
|
||||
</kbd>
|
||||
+
|
||||
</KeyboardKey>
|
||||
<KeyboardKey
|
||||
last={true}
|
||||
name="b"
|
||||
>
|
||||
<kbd>
|
||||
|
||||
b
|
||||
|
||||
</kbd>
|
||||
</KeyboardKey>
|
||||
</div>
|
||||
</KeyboardShortcut>
|
||||
</div>
|
||||
</KeyboardShortcutRow>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</KeyboardShortcutSection>
|
||||
<KeyboardShortcutSection
|
||||
category={
|
||||
Object {
|
||||
"categoryLabel": "Navigation",
|
||||
"settingNames": Array [
|
||||
"keybind3",
|
||||
],
|
||||
}
|
||||
}
|
||||
categoryName="Navigation"
|
||||
key="Navigation"
|
||||
>
|
||||
<div
|
||||
className="mx_SettingsTab_section"
|
||||
key="Navigation"
|
||||
>
|
||||
<div
|
||||
className="mx_SettingsTab_subheading"
|
||||
>
|
||||
missing translation: en|Navigation
|
||||
</div>
|
||||
<div>
|
||||
|
||||
<KeyboardShortcutRow
|
||||
key="keybind3"
|
||||
name="keybind3"
|
||||
>
|
||||
<div
|
||||
className="mx_KeyboardShortcut_shortcutRow"
|
||||
>
|
||||
Select room from the room list
|
||||
<KeyboardShortcut
|
||||
name="keybind3"
|
||||
>
|
||||
<div>
|
||||
<KeyboardKey
|
||||
last={true}
|
||||
name="Enter"
|
||||
>
|
||||
<kbd>
|
||||
|
||||
missing translation: en|Enter
|
||||
|
||||
</kbd>
|
||||
</KeyboardKey>
|
||||
</div>
|
||||
</KeyboardShortcut>
|
||||
</div>
|
||||
</KeyboardShortcutRow>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
</KeyboardShortcutSection>
|
||||
</div>
|
||||
</KeyboardUserSettingsTab>
|
||||
`;
|
||||
Loading…
Add table
Add a link
Reference in a new issue