Skip to content

[No QA] Simplify and upgrade KeyboardShortcut library #8059

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thienlnam merged 14 commits into from
Mar 10, 2022
Merged

[No QA] Simplify and upgrade KeyboardShortcut library #8059

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
18be748
Install shim-keyboard-event-key to support older browsers
roryabraham Mar 9, 2022
7f88aaf
Rename poorly names eventHandler map
roryabraham Mar 9, 2022
af52c65
Use key+modifiers as keys in callback map
roryabraham Mar 9, 2022
6c29498
Implement event bubbling
roryabraham Mar 9, 2022
03fcb04
Implement priority
roryabraham Mar 9, 2022
80d4c0a
Fix toUpperCase bug
roryabraham Mar 9, 2022
56e717c
Move platform-specific key adjustment into KeyboardShortcut lib
roryabraham Mar 9, 2022
acbf212
Clarify the role of the documented shortcuts map
roryabraham Mar 9, 2022
7db67a4
Make exports match in index.native.js
roryabraham Mar 9, 2022
d31da7c
Fix bindHandlerToKeydownEvent
roryabraham Mar 9, 2022
b31d30a
Fix ESC in keyboard shortcut modal
roryabraham Mar 9, 2022
5ba4816
Improve JSDocs
roryabraham Mar 9, 2022
b179109
Allow Buttons to assign priority to their enter key event listener
roryabraham Mar 9, 2022
fe4467a
Remove unnecessary blank line
roryabraham Mar 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,7 @@
"react-web-config": "^1.0.0",
"rn-fetch-blob": "^0.12.0",
"save": "^2.4.0",
"shim-keyboard-event-key": "^1.0.3",
"smoothscroll-polyfill": "^0.4.4",
"underscore": "^1.13.1",
"urbanairship-react-native": "^11.0.2"
Expand Down
7 changes: 4 additions & 3 deletions src/CONST.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ const CONST = {
WEB: 'web',
DESKTOP: 'desktop',
},
KEYBOARD_SHORTCUT_MODIFIERS: {
PLATFORM_SPECIFIC_KEYS: {
CTRL: {
DEFAULT: 'control',
[PLATFORM_OS_MACOS]: 'meta',
Expand Down Expand Up @@ -176,8 +176,9 @@ const CONST = {
},
},
KEYBOARD_SHORTCUT_KEY_DISPLAY_NAME: {
CONTROL: 'Ctrl',
META: 'Cmd',
CONTROL: 'CTRL',
ESCAPE: 'ESC',
META: 'CMD',

@thienlnam thienlnam Mar 9, 2022

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Small question: How come this is called the META key instead of COMMAND?

@roryabraham roryabraham Mar 10, 2022

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

IDK

SHIFT: 'Shift',
},
CURRENCY: {
Expand Down
6 changes: 5 additions & 1 deletion src/components/Button.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ const propTypes = {
/** Call the onPress function when Enter key is pressed */
pressOnEnter: PropTypes.bool,

/** The priority to assign the enter key event listener. 0 is the highest priority. */
enterKeyEventListenerPriority: PropTypes.number,

/** Additional styles to add after local styles. Applied to Pressable portion of button */
style: PropTypes.oneOfType([
PropTypes.arrayOf(PropTypes.object),
Expand Down Expand Up @@ -92,6 +95,7 @@ const defaultProps = {
onPressIn: () => {},
onPressOut: () => {},
pressOnEnter: false,
enterKeyEventListenerPriority: 0,
style: [],
innerStyles: [],
textStyles: [],
Expand Down Expand Up @@ -124,7 +128,7 @@ class Button extends Component {
return;
}
this.props.onPress();
}, shortcutConfig.descriptionKey, shortcutConfig.modifiers, true);
}, shortcutConfig.descriptionKey, shortcutConfig.modifiers, true, false, this.props.enterKeyEventListenerPriority);
}

componentWillUnmount() {
Expand Down
5 changes: 2 additions & 3 deletions src/components/KeyboardShortcutsModal.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,9 @@ const defaultProps = {
class KeyboardShortcutsModal extends React.Component {
componentDidMount() {
const shortcutConfig = CONST.KEYBOARD_SHORTCUTS.SHORTCUT_MODAL;
const shortcutModifiers = KeyboardShortcut.getShortcutModifiers(shortcutConfig.modifiers);
this.unsubscribeShortcutModal = KeyboardShortcut.subscribe(shortcutConfig.shortcutKey, () => {
KeyboardShortcutsActions.showKeyboardShortcutModal();
}, shortcutConfig.descriptionKey, shortcutModifiers, true);
}, shortcutConfig.descriptionKey, shortcutConfig.modifiers, true);
}

componentWillUnmount() {
Expand Down Expand Up @@ -73,7 +72,7 @@ class KeyboardShortcutsModal extends React.Component {
}

render() {
const shortcuts = KeyboardShortcut.getKeyboardShortcuts();
const shortcuts = KeyboardShortcut.getDocumentedShortcuts();
const modalType = this.props.isSmallScreenWidth ? CONST.MODAL.MODAL_TYPE.BOTTOM_DOCKED : CONST.MODAL.MODAL_TYPE.CENTERED_UNSWIPEABLE;

return (
Expand Down
Loading