Adds tab function to docs and typings #184
Conversation
Codecov Report
@@ Coverage Diff @@
## master #184 +/- ##
======================================
Coverage 97.1% 97.1%
======================================
Files 1 1
Lines 138 138
Branches 35 35
======================================
Hits 134 134
Misses 4 4Continue to review full report at Codecov.
|
typings/index.d.ts
Outdated
| @@ -15,6 +15,7 @@ declare const userEvent: { | |||
| text: string, | |||
| userOpts?: IUserOptions | |||
| ) => Promise<void>; | |||
| tab: (userOpts?: { shift: boolean }) => void; | |||
There was a problem hiding this comment.
This type is no longer up to date. Could you add focusTrap to it?
better yet, define an interface and add defaults to the options (edit: can't have defaults in interface, oops)
interface TabUserOptions {
shift?: boolean;
focusTrap?: Document;
}
declare const userEvent: {
...
tab: (userOpts?: TabUserOptions) => void;
};There was a problem hiding this comment.
Should the type of focusTrap be TargetElement which is defined as type TargetElement = Element | Window;?
There was a problem hiding this comment.
Or maybe it needs to be Document | Element?
There was a problem hiding this comment.
Looking at lib.dom.d.ts querySelectorAll is defined in ParentNode which Document and Element both extend, so Document | Element seems like the correct choice.
There was a problem hiding this comment.
Are you happy with the current state?
|
🎉 This PR is included in version 8.0.1 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Just a simple patch to add the tab function to docs and typings.