4949
5050### ` click(element, eventInit, options) `
5151
52- Clicks ` element ` , depending on what ` element ` is clicked, calling ` click() ` can have different side
53- effects.
52+ Clicks ` element ` , depending on what ` element ` is clicked, calling ` click() ` can
53+ have different side effects.
5454
5555``` jsx
5656import React from ' react'
@@ -81,9 +81,24 @@ See the
8181constructor documentation for more options.
8282
8383Note that ` click ` will trigger hover events before clicking. To disable this,
84- set the ` skipHover ` option to ` true ` . Also note that trying to click an element
85- with ` pointer-events ` being set to ` "none" ` (i.e. unclickable) will throw an
86- error.
84+ set the ` skipHover ` option to ` true ` .
85+
86+ #### Pointer events options
87+
88+ Trying to click an element with ` pointer-events ` being set to ` "none" ` (i.e.
89+ unclickable) will throw an error. If you want to disable this behavior you can
90+ set ` skipPointerEventsCheck ` to ` true ` :
91+
92+ ``` js
93+ userEvent .click (elem, undefined , {skipPointerEventsCheck: true })
94+ ```
95+
96+ The ` skipPointerEventsCheck ` option can be passed to any pointer related API including:
97+ - [ dblClick] ( #dblclickelement-eventinit-options )
98+ - [ hover] ( #hoverelement-options )
99+ - [ unhover] ( #unhoverelement-options )
100+ - [ selectOptions] ( #selectoptionselement-values-options )
101+ - [ deselectOptions] ( #deselectoptionselement-values-options )
87102
88103### ` dblClick(element, eventInit, options) `
89104
@@ -105,6 +120,8 @@ test('double click', () => {
105120})
106121```
107122
123+ Note: ` options ` includes [ Pointer events options] ( #pointer-events-options )
124+
108125### ` type(element, text, [options]) `
109126
110127Writes ` text ` inside an ` <input> ` or a ` <textarea> ` .
@@ -352,7 +369,7 @@ test('clear', () => {
352369})
353370```
354371
355- ### ` selectOptions(element, values) `
372+ ### ` selectOptions(element, values, options ) `
356373
357374Selects the specified option(s) of a ` <select> ` or a ` <select multiple> `
358375element.
@@ -391,7 +408,9 @@ userEvent.selectOptions(screen.getByTestId('select-multiple'), [
391408])
392409```
393410
394- ### ` deselectOptions(element, values) `
411+ Note: ` options ` includes [ Pointer events options] ( #pointer-events-options )
412+
413+ ### ` deselectOptions(element, values, options) `
395414
396415Remove the selection for the specified option(s) of a ` <select multiple> `
397416element.
@@ -422,6 +441,8 @@ test('deselectOptions', () => {
422441The ` values ` parameter can be either an array of values or a singular scalar
423442value.
424443
444+ Note: ` options ` includes [ Pointer events options] ( #pointer-events-options )
445+
425446### ` tab({shift, focusTrap}) `
426447
427448Fires a tab event changing the document.activeElement in the same way the
@@ -483,7 +504,7 @@ it('should cycle elements in document tab order', () => {
483504})
484505```
485506
486- ### ` hover(element) `
507+ ### ` hover(element, options ) `
487508
488509Hovers over ` element ` .
489510
@@ -508,12 +529,16 @@ test('hover', () => {
508529})
509530```
510531
511- ### ` unhover(element) `
532+ Note: ` options ` includes [ Pointer events options] ( #pointer-events-options )
533+
534+ ### ` unhover(element, options) `
512535
513536Unhovers out of ` element ` .
514537
515538> See [ above] ( #hoverelement ) for an example
516539
540+ Note: ` options ` includes [ Pointer events options] ( #pointer-events-options )
541+
517542### ` paste(element, text, eventInit, options) `
518543
519544Allows you to simulate the user pasting some text into an input.
0 commit comments