compose: Add types to useKeyboardShortcut
#32168
Merged
Conversation
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
sarayourfriend
added
[Type] Code Quality
|
Size Change: +3 B (0%) Total Size: 1.86 MB
ℹ️ View Unchanged
|
sarayourfriend
changed the title
useKeyboartShortcutuseKeyboardShortcut
sarayourfriend
force-pushed
the
add/types-compose-keyboard-shortcut
branch
from
094215f
to
3432cf1
Compare
ellatrix
reviewed
May 24, 2021
packages/compose/README.md
Outdated
| _Parameters_ | ||
|
|
||
| - _shortcuts_ `string[]|string`: Keyboard Shortcuts. | ||
| - _callback_ `Function`: Shortcut callback. | ||
| - _callback_ `import('mousetrap').MousetrapInstance['bind']`: Shortcut callback. |
There was a problem hiding this comment.
Isn't this just a DOM event callback?
There was a problem hiding this comment.
It's not quite, from the types:
bind(
keys: string | string[],
callback: (e: ExtendedKeyboardEvent, combo: string) => any,
action?: string,
): this;
There was a problem hiding this comment.
Shouldn't the callback be of type (e: ExtendedKeyboardEvent, combo: string) => any ?
There was a problem hiding this comment.
Oh shoot you're right, the callback is passed as the second param to bind, my bad. I'll fix this.
sarayourfriend
force-pushed
the
add/types-compose-keyboard-shortcut
branch
2 times, most recently
from
e695333
to
299cf62
Compare
ciampo
reviewed
May 26, 2021
sarayourfriend
force-pushed
the
add/types-compose-keyboard-shortcut
branch
from
299cf62
to
0ab8ebe
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Adds/corrects types to
useKeyboardShortcut. There were pre-existing types but they weren't being type-checked.Part of #18838
How has this been tested?
Type checks pass. No runtime changes that should affect anything except for an extra null check.
Types of changes
New feature.
Checklist:
*.native.jsfiles for terms that need renaming or removal).