-
Notifications
You must be signed in to change notification settings - Fork 179
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.
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
feat(app): Add keyboard shortcuts to jog controls #1761
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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,61 @@ | ||
// @flow | ||
import * as React from 'react' | ||
|
||
type KeypressEvent = SyntheticKeyboardEvent<*> | ||
|
||
type KeypressHandler = { | ||
key: string, | ||
shiftKey?: ?boolean, | ||
onPress: () => mixed, | ||
} | ||
|
||
type Props = { | ||
/** array of keypress handlers to attach to the window */ | ||
handlers: Array<KeypressHandler>, | ||
/** wrapped children */ | ||
children?: React.Node, | ||
} | ||
|
||
const matchHandler = e => h => ( | ||
h.key === e.key && | ||
(h.shiftKey == null || h.shiftKey === e.shiftKey) | ||
) | ||
|
||
/** | ||
* Keypress handler wrapper component. Takes an array of keypress handlers | ||
* to call when a given key is pressed on the keyboard. Handler is called on | ||
* `keyup` event. `event.preventDefault` will be called if a key is handled. | ||
*/ | ||
export default class HandleKeypress extends React.Component<Props> { | ||
handlePressIfKey = (event: KeypressEvent) => { | ||
this.props.handlers | ||
.filter(matchHandler(event)) | ||
.forEach(h => h.onPress()) | ||
} | ||
|
||
preventDefaultIfKey = (event: KeypressEvent) => { | ||
const pressHandled = this.props.handlers.some(matchHandler(event)) | ||
|
||
if (pressHandled) event.preventDefault() | ||
} | ||
|
||
componentDidMount () { | ||
window.addEventListener('keyup', this.handlePressIfKey) | ||
window.addEventListener('keyup', this.preventDefaultIfKey) | ||
window.addEventListener('keydown', this.preventDefaultIfKey) | ||
} | ||
|
||
componentWillUnmount () { | ||
window.removeEventListener('keyup', this.handlePressIfKey) | ||
window.removeEventListener('keyup', this.preventDefaultIfKey) | ||
window.removeEventListener('keydown', this.preventDefaultIfKey) | ||
} | ||
|
||
render () { | ||
return ( | ||
<React.Fragment> | ||
{this.props.children} | ||
</React.Fragment> | ||
) | ||
} | ||
} |
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,17 @@ | ||
Use `<HandleKeypress>` to register listeners for keypress events: | ||
|
||
```js | ||
initialState = {key: ''} | ||
|
||
;<HandleKeypress | ||
handlers={[ | ||
{key: 'q', onPress: () => setState({key: 'q'})}, | ||
{key: 'w', onPress: () => setState({key: 'w'})}, | ||
{key: 'e', onPress: () => setState({key: 'e'})}, | ||
{key: 'ArrowLeft', shiftKey: false, onPress: () => setState({key: 'left'})}, | ||
{key: 'ArrowRight', shiftKey: true, onPress: () => setState({key: 'shift + right'})} | ||
]} | ||
> | ||
Key: {state.key} | ||
</HandleKeypress> | ||
``` |
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 |
---|---|---|
@@ -1,7 +1,10 @@ | ||
// @flow | ||
import clickOutside from './clickOutside' | ||
import HandleKeypress from './HandleKeypress' | ||
|
||
export type {ClickOutsideInterface} from './clickOutside' | ||
|
||
export { | ||
clickOutside | ||
clickOutside, | ||
HandleKeypress | ||
} |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🍾