@@ -52,8 +52,8 @@ change the state of the checkbox.
5252
5353- [ Installation] ( #installation )
5454- [ API] ( #api )
55- - [ ` click(element) ` ] ( #clickelement )
56- - [ ` dblClick(element) ` ] ( #dblclickelement )
55+ - [ ` click(element, eventInit, options ) ` ] ( #clickelement-eventinit-options )
56+ - [ ` dblClick(element, eventInit, options ) ` ] ( #dblclickelement-eventinit-options )
5757 - [ ` async type(element, text, [options]) ` ] ( #async-typeelement-text-options )
5858 - [ ` upload(element, file, [{ clickInit, changeInit }]) ` ] ( #uploadelement-file--clickinit-changeinit- )
5959 - [ ` clear(element) ` ] ( #clearelement )
@@ -95,7 +95,7 @@ var userEvent = require('@testing-library/user-event')
9595
9696## API
9797
98- ### ` click(element) `
98+ ### ` click(element, eventInit, options ) `
9999
100100Clicks ` element ` , depending on what ` element ` is it can have different side
101101effects.
@@ -128,7 +128,10 @@ See the
128128[ ` MouseEvent ` ] ( https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/MouseEvent )
129129constructor documentation for more options.
130130
131- ### ` dblClick(element) `
131+ Note that ` click ` will trigger hover events before clicking. To disable this,
132+ set the ` skipHover ` option to ` true ` .
133+
134+ ### ` dblClick(element, eventInit, options) `
132135
133136Clicks ` element ` twice, depending on what ` element ` is it can have different
134137side effects.
@@ -169,6 +172,9 @@ test('type', async () => {
169172are typed. By default it's 0. You can use this option if your component has a
170173different behavior for fast or slow users.
171174
175+ ` type ` will click the element before typing. To disable this, set the
176+ ` skipClick ` option to ` true ` .
177+
172178#### Special characters
173179
174180The following special character strings are supported:
@@ -187,7 +193,9 @@ The following special character strings are supported:
187193
188194> ** A note about modifiers:** Modifier keys (` {shift} ` , ` {ctrl} ` , ` {alt} ` ,
189195> ` {meta} ` ) will activate their corresponding event modifiers for the duration
190- > of type command or until they are closed (via ` {/shift} ` , ` {/ctrl} ` , etc.).
196+ > of type command or until they are closed (via ` {/shift} ` , ` {/ctrl} ` , etc.). If
197+ > they are not closed explicitly, then events will be fired to close them
198+ > automatically (to disable this, set the ` skipAutoClose ` option to ` true ` ).
191199
192200<!-- space out these notes -->
193201
0 commit comments