forked from matrix-org/matrix-react-sdk
-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Keybinding code unification #6 (matrix-org#8042)
- Loading branch information
1 parent
e725f14
commit 8d13e23
Showing
10 changed files
with
462 additions
and
351 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| /* | ||
| 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 { KeyCombo } from "../KeyBindingsManager"; | ||
| import { isMac, Key } from "../Keyboard"; | ||
| import { _t, _td } from "../languageHandler"; | ||
| import PlatformPeg from "../PlatformPeg"; | ||
| import SettingsStore from "../settings/SettingsStore"; | ||
| import { | ||
| DESKTOP_SHORTCUTS, | ||
| DIGITS, | ||
| IKeyboardShortcuts, | ||
| KeyBindingAction, | ||
| KEYBOARD_SHORTCUTS, | ||
| MAC_ONLY_SHORTCUTS, | ||
| } from "./KeyboardShortcuts"; | ||
|
|
||
| /** | ||
| * This function gets the keyboard shortcuts that should be presented in the UI | ||
| * but they shouldn't be consumed by KeyBindingDefaults. That means that these | ||
| * have to be manually mirrored in KeyBindingDefaults. | ||
| */ | ||
| const getUIOnlyShortcuts = (): IKeyboardShortcuts => { | ||
| const ctrlEnterToSend = SettingsStore.getValue('MessageComposerInput.ctrlEnterToSend'); | ||
|
|
||
| const keyboardShortcuts: IKeyboardShortcuts = { | ||
| [KeyBindingAction.SendMessage]: { | ||
| default: { | ||
| key: Key.ENTER, | ||
| ctrlOrCmdKey: ctrlEnterToSend, | ||
| }, | ||
| displayName: _td("Send message"), | ||
| }, | ||
| [KeyBindingAction.NewLine]: { | ||
| default: { | ||
| key: Key.ENTER, | ||
| shiftKey: !ctrlEnterToSend, | ||
| }, | ||
| displayName: _td("New line"), | ||
| }, | ||
| [KeyBindingAction.CompleteAutocomplete]: { | ||
| default: { | ||
| key: Key.ENTER, | ||
| }, | ||
| displayName: _td("Complete"), | ||
| }, | ||
| [KeyBindingAction.ForceCompleteAutocomplete]: { | ||
| default: { | ||
| key: Key.TAB, | ||
| }, | ||
| displayName: _td("Force complete"), | ||
| }, | ||
| [KeyBindingAction.SearchInRoom]: { | ||
| default: { | ||
| ctrlOrCmdKey: true, | ||
| key: Key.F, | ||
| }, | ||
| displayName: _td("Search (must be enabled)"), | ||
| }, | ||
| }; | ||
|
|
||
| if (PlatformPeg.get().overrideBrowserShortcuts()) { | ||
| // XXX: This keyboard shortcut isn't manually added to | ||
| // KeyBindingDefaults as it can't be easily handled by the | ||
| // KeyBindingManager | ||
| keyboardShortcuts[KeyBindingAction.SwitchToSpaceByNumber] = { | ||
| default: { | ||
| ctrlOrCmdKey: true, | ||
| key: DIGITS, | ||
| }, | ||
| displayName: _td("Switch to space by number"), | ||
| }; | ||
| } | ||
|
|
||
| return keyboardShortcuts; | ||
| }; | ||
|
|
||
| /** | ||
| * This function gets keyboard shortcuts that can be consumed by the KeyBindingDefaults. | ||
| */ | ||
| export const getKeyboardShortcuts = (): IKeyboardShortcuts => { | ||
| const overrideBrowserShortcuts = PlatformPeg.get().overrideBrowserShortcuts(); | ||
|
|
||
| return Object.keys(KEYBOARD_SHORTCUTS).filter((k: KeyBindingAction) => { | ||
| if (KEYBOARD_SHORTCUTS[k]?.controller?.settingDisabled) return false; | ||
| if (MAC_ONLY_SHORTCUTS.includes(k) && !isMac) return false; | ||
| if (DESKTOP_SHORTCUTS.includes(k) && !overrideBrowserShortcuts) return false; | ||
|
|
||
| return true; | ||
| }).reduce((o, key) => { | ||
| o[key] = KEYBOARD_SHORTCUTS[key]; | ||
| return o; | ||
| }, {} as IKeyboardShortcuts); | ||
| }; | ||
|
|
||
| /** | ||
| * Gets keyboard shortcuts that should be presented to the user in the UI. | ||
| */ | ||
| export const getKeyboardShortcutsForUI = (): IKeyboardShortcuts => { | ||
| const entries = [ | ||
| ...Object.entries(getUIOnlyShortcuts()), | ||
| ...Object.entries(getKeyboardShortcuts()), | ||
| ]; | ||
|
|
||
| return entries.reduce((acc, [key, value]) => { | ||
| acc[key] = value; | ||
| return acc; | ||
| }, {} as IKeyboardShortcuts); | ||
| }; | ||
|
|
||
| export const getKeyboardShortcutValue = (name: string): KeyCombo => { | ||
| return getKeyboardShortcutsForUI()[name]?.default; | ||
| }; | ||
|
|
||
| export const getKeyboardShortcutDisplayName = (name: string): string | null => { | ||
| const keyboardShortcutDisplayName = getKeyboardShortcutsForUI()[name]?.displayName; | ||
| return keyboardShortcutDisplayName && _t(keyboardShortcutDisplayName); | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| /* | ||
| 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 { ALTERNATE_KEY_NAME, KEY_ICON } from "../../../accessibility/KeyboardShortcuts"; | ||
| import { KeyCombo } from "../../../KeyBindingsManager"; | ||
| import { isMac, Key } from "../../../Keyboard"; | ||
| import { _t } from "../../../languageHandler"; | ||
|
|
||
| interface IKeyboardKeyProps { | ||
| name: string; | ||
| last?: boolean; | ||
| } | ||
|
|
||
| export const KeyboardKey: React.FC<IKeyboardKeyProps> = ({ name, last }) => { | ||
| const icon = KEY_ICON[name]; | ||
| const alternateName = ALTERNATE_KEY_NAME[name]; | ||
|
|
||
| return <React.Fragment> | ||
| <kbd> { icon || (alternateName && _t(alternateName)) || name } </kbd> | ||
| { !last && "+" } | ||
| </React.Fragment>; | ||
| }; | ||
|
|
||
| interface IKeyboardShortcutProps { | ||
| value: KeyCombo; | ||
| } | ||
|
|
||
| export const KeyboardShortcut: React.FC<IKeyboardShortcutProps> = ({ value }) => { | ||
| if (!value) return null; | ||
|
|
||
| const modifiersElement = []; | ||
| if (value.ctrlOrCmdKey) { | ||
| modifiersElement.push(<KeyboardKey key="ctrlOrCmdKey" name={isMac ? Key.META : Key.CONTROL} />); | ||
| } else if (value.ctrlKey) { | ||
| modifiersElement.push(<KeyboardKey key="ctrlKey" name={Key.CONTROL} />); | ||
| } else if (value.metaKey) { | ||
| modifiersElement.push(<KeyboardKey key="metaKey" name={Key.META} />); | ||
| } | ||
| if (value.altKey) { | ||
| modifiersElement.push(<KeyboardKey key="altKey" name={Key.ALT} />); | ||
| } | ||
| if (value.shiftKey) { | ||
| modifiersElement.push(<KeyboardKey key="shiftKey" name={Key.SHIFT} />); | ||
| } | ||
|
|
||
| return <div> | ||
| { modifiersElement } | ||
| <KeyboardKey name={value.key} last /> | ||
| </div>; | ||
| }; | ||
|
|
||
| export default KeyboardShortcut; |
Oops, something went wrong.