feat: add capslock to userEvent.type #507
Conversation
Codecov Report
@@ Coverage Diff @@
## master #507 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 13 13
Lines 615 625 +10
Branches 200 200
=========================================
+ Hits 615 625 +10
Continue to review full report at Codecov.
|
| input[value=""] - pointerup | ||
| input[value=""] - mouseup: Left (0) | ||
| input[value=""] - click: Left (0) | ||
| input[value=""] - keydown: CapsLock (20) |
There was a problem hiding this comment.
Ah, this one is tricky. Basically for caps lock, it should keydown and keyup here, but preserve the modifier state. Hmmm...
There was a problem hiding this comment.
So, do you think a PR will also be needed to fireEvent for the case of CapsLock?
There was a problem hiding this comment.
No, fireEvent is all about dispatching individual events in complete isolation. It is not concerned about state. This will only need to happen here in user-event. It's possible we won't be able to re-use the existing createModifierCallbackEntries for this one.
There was a problem hiding this comment.
Scratch that. Updated with a switch/case. I'm not sure if it's initially beneficial to write it that way, but I didn't know if other modifier keys might also require the behavior at some point.
There was a problem hiding this comment.
Saw the comment after. I can write a separate function for it if preferred?
There was a problem hiding this comment.
@Sonic12040, could you try removing the custom logic and inlining it for the caps lock. I think that will result in simpler code in this case. I'm worried that this is a hasty abstraction (AHA Programming) and I think the small amount of duplication will be better.
There was a problem hiding this comment.
Updated with a duplicate function that performs the CapsLock behavior.
| input[value="a"] - input | ||
| "{CURSOR}" -> "a{CURSOR}" | ||
| input[value="a"] - keyup: a (97) | ||
| input[value="a"] - keyup: CapsLock (20) |
There was a problem hiding this comment.
And then this should keydown and keyup and disable the modifier state. I'm afraid this one isn't quite as simple as I thought at first.
…r keys that also need aberrant behaviors
src/type.js
Outdated
| @@ -42,6 +42,12 @@ const modifierCallbackMap = { | |||
| keyCode: 93, | |||
| modifierProperty: 'metaKey', | |||
| }), | |||
| ...createCapsLockModifierCallbackEntries({ | |||
There was a problem hiding this comment.
Rather than using a function, maybe it would make more sense to just inline this one with a comment explaining why it can't use createModifierCallbackEntries?
There was a problem hiding this comment.
Done. Sorry about the delay; I missed this comment at first.
|
@all-contributors please add @Sonic12040 for code, tests, and docs |
|
I've put up a pull request to add @Sonic12040! 🎉 |
|
Thanks so much for your help! I've added you as a collaborator on the project. Please make sure that you review the |
|
🎉 This PR is included in version 12.3.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
What: Adding CapsLock to the modifier key support so that tests using CapsLock can be implemented.
Why: When typing and using the CapsLock modifier, we need to be able to write tests that implement the CapsLock key.
How: Added a test to the type-modifiers file, then implemented the suggested changes from Kent C Dodds office hours to the type file.
Checklist: