KeyboardShortcuts: Convert to TypeScript #47429
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
|
Size Change: +7 B (0%) Total Size: 1.31 MB
ℹ️ View Unchanged
|
mirka
commented
Jan 25, 2023
| bindGlobal, | ||
| eventName, | ||
| }: KeyboardShortcutsProps ) { | ||
| const target = useRef( null ); |
There was a problem hiding this comment.
Runtime change. Should be safe.
- const target = useRef();
+ const target = useRef( null );
Comment on lines
+81
to
+83
| if ( ! Children.count( children ) ) { | ||
| return <>{ element }</>; | ||
| } |
There was a problem hiding this comment.
Runtime change. Without it, KeyboardShortcuts basically becomes invalid as a React component.
- return element;
+ return <>{ element }</>;
Comment on lines
20
to
23
| // @ts-expect-error | ||
| event.keyCode = which; | ||
| // @ts-expect-error | ||
| event.which = which; |
There was a problem hiding this comment.
I think these are inevitable, because fireEvent() requires the event argument to be of type Event and not the more specific KeyboardEvent. I'm happy to be wrong though.
There was a problem hiding this comment.
I tried using createEvent (also imported from @testing-library/react) locally which seems to work and circumvent the TS error:
function keyPress(
which: number,
target: Parameters< typeof fireEvent >[ 0 ]
) {
[ 'keydown', 'keypress', 'keyup' ].forEach( ( eventName ) => {
const event = createEvent(
eventName,
target,
{
bubbles: true,
keyCode: which,
which,
},
{ EventType: 'KeyboardEvent' }
);
fireEvent( target, event );
} );
}Although if you'd assign event.which after the event was created it'd still warn that which (or keyCode) doesn't exist on Event.
Comment on lines
+6
to
+9
| type WPKeyboardShortcutConfig = NonNullable< | ||
| Parameters< typeof useKeyboardShortcut >[ 2 ] | ||
| >; |
There was a problem hiding this comment.
A bit weird, but the WPKeyboardShortcutConfig type is not directly exported from the wp-compose package. I generally want to avoid doing fragile index-based access on Parameters<>, but 🤷
I've tried to balance readability and DRYness in this types file. Hope it doesn't look too random 😅
There was a problem hiding this comment.
Yeah, this looks like a good compromise. The only improvement that comes to mind is to add a little inline comment, basically explaining that the reason why we're doing this, is because that type is not exported.
As a small follow-up PR, we may even consider exporting that type from compose package and therefore update this line of code too.
|
Flaky tests detected in 7893c96. 🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/4008594181
|
ciampo
reviewed
Jan 26, 2023
Comment on lines
+6
to
+9
| type WPKeyboardShortcutConfig = NonNullable< | ||
| Parameters< typeof useKeyboardShortcut >[ 2 ] | ||
| >; |
There was a problem hiding this comment.
Yeah, this looks like a good compromise. The only improvement that comes to mind is to add a little inline comment, basically explaining that the reason why we're doing this, is because that type is not exported.
As a small follow-up PR, we may even consider exporting that type from compose package and therefore update this line of code too.
| export type KeyboardShortcutProps = { | ||
| shortcut: string | string[]; | ||
| /** | ||
| * @see {@link https://craig.is/killing/mice Mousetrap documentation} |
| */ | ||
| import KeyboardShortcuts from '..'; | ||
|
|
||
| const meta: ComponentMeta< typeof KeyboardShortcuts > = { |
There was a problem hiding this comment.
Thank you for adding Storybook examples!
ciampo
approved these changes
Jan 28, 2023
Co-authored-by: flootr <m.do@posteo.net>
mirka
force-pushed
the
ts-keyboard-shortcuts
branch
from
359efa5
to
096bf8f
Compare
juanmaguitar
added
the
[Type] Code Quality
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.
Part of #35744
What?
Converts the
KeyboardShortcutscomponent to TypeScript.Testing Instructions
npm run storybook:devand see the story/docs for KeyboardShortcuts.