feat(type): support special charaters (like {enter}) #308
Conversation
Codecov Report
@@ Coverage Diff @@
## master #308 +/- ##
==========================================
+ Coverage 98.93% 99.20% +0.27%
==========================================
Files 1 2 +1
Lines 188 253 +65
Branches 56 66 +10
==========================================
+ Hits 186 251 +65
Misses 2 2
Continue to review full report at Codecov.
|
|
🎉 This PR is included in version 11.1.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
| }) | ||
| } | ||
|
|
||
| if (currentElement().tagName === 'BUTTON') { |
There was a problem hiding this comment.
Good thinking here! I didn't even think about non-text elements. Now that I am though, would it be appropriate to also handle <input type="button" />, <input type="submit" />, etc?
|
|
||
| await userEvent.type(input, '{esc}') | ||
|
|
||
| expect(getEventCalls()).toMatchInlineSnapshot(` |
There was a problem hiding this comment.
This is such a slick method of testing. I ran into this same problem where tests became super hairy and difficult to reason about, but this is awesome 🤯
|
|
||
| > **A note about modifiers:** Modifier keys (`{shift}`, `{ctrl}`, `{alt}`, | ||
| > `{meta}`) will activate their corresponding event modifiers for the duration | ||
| > of type command or until they are closed (via `{/shift}`, `{/ctrl}`, etc.). |
There was a problem hiding this comment.
I do like the extra control we get here by adding {/shift} (compared to cypress), but worry that maybe it's a bit too verbose for most use cases.
Perhaps you could release modifier keys at the end of the type statement if no closing modifiers are provided? That could be the best of both worlds. I don't think there's any use case for keeping these keys held down at the end of a type statement (since you don't get the event modifiers after it's done).
| ...newEventOverrides, | ||
| }) | ||
|
|
||
| return {eventOverrides: newEventOverrides} |
There was a problem hiding this comment.
I think you want to return both eventOverrides AND newEventOverrides here. Otherwise multiple held modifiers don't work correctly (such as userEvent.type('{ctrl}{meta}{enter}'))
There was a problem hiding this comment.
Actually, we merge the old eventOverrides with the new ones elsewhere so we're good here 👍
|
@malwilley, love all the feedback. Would you like to make a pull request to implement it all? |
|
Sure thing! |
|
We're moving user-event to within dom-testing-library and I just added the auto-release feature :) testing-library/dom-testing-library@bebfc74 If you'd like, there's plenty of opportunity to help still: testing-library/dom-testing-library#616 |
What: feat(type): support special characters (like
{enter})Why:
Closes #306
Closes #301
Closes #235
Closes #181
Closes #172
Closes #31
How:
Oh boy... Totally reworked the
typefunctionality. Also made some pretty cool utilities for the tests which might be useful elsewhere.Checklist: