diff --git a/docs/ecosystem-user-event.mdx b/docs/ecosystem-user-event.mdx index 4429c36af..c94009810 100644 --- a/docs/ecosystem-user-event.mdx +++ b/docs/ecosystem-user-event.mdx @@ -49,8 +49,8 @@ in ### `click(element, eventInit, options)` -Clicks `element`, depending on what `element` is clicked, calling `click()` can have different side -effects. +Clicks `element`, depending on what `element` is clicked, calling `click()` can +have different side effects. ```jsx import React from 'react' @@ -81,9 +81,24 @@ See the constructor documentation for more options. Note that `click` will trigger hover events before clicking. To disable this, -set the `skipHover` option to `true`. Also note that trying to click an element -with `pointer-events` being set to `"none"` (i.e. unclickable) will throw an -error. +set the `skipHover` option to `true`. + +#### Pointer events options + +Trying to click an element with `pointer-events` being set to `"none"` (i.e. +unclickable) will throw an error. If you want to disable this behavior you can +set `skipPointerEventsCheck` to `true`: + +```js +userEvent.click(elem, undefined, {skipPointerEventsCheck: true}) +``` + +The `skipPointerEventsCheck` option can be passed to any pointer related API including: +- [dblClick](#dblclickelement-eventinit-options) +- [hover](#hoverelement-options) +- [unhover](#unhoverelement-options) +- [selectOptions](#selectoptionselement-values-options) +- [deselectOptions](#deselectoptionselement-values-options) ### `dblClick(element, eventInit, options)` @@ -105,6 +120,8 @@ test('double click', () => { }) ``` +Note: `options` includes [Pointer events options](#pointer-events-options) + ### `type(element, text, [options])` Writes `text` inside an `` or a `