feat: add flag to skip pointer-events check

[jesperorb]

What:

This PR adds a new flag called skipPointerEventsCheck which makes it possible to skip checking for pointer-events: "none" when using different user events like click or dblclick.

This PR does not add a global config flag as per discussion in: #729

Why:

As per discussion in: #729

Adding the check for hasPointerEvents increase the time to execute each click and hover or anything that relies on pointer-events. The increased time for each click can be quite drastic depending on how large of a DOM-tree you are rendering in your tests as it checks if any parent has the property set.

Making it optional can speed up tests. If you for example know that the property is not set in the code your are testing. Or if you want to disable it momentarily when developing and the run it later on in the CI.

How:

Adding a common interface for pointer events that has the property skipPointerEventsCheck and using this flag anywhere the check hasPointerEvents is being used.

Checklist:

• Documentation
• Tests
• Ready to be merged
  

Feedback and questions

• What counts as Documentation in the checklist?

[codesandbox-ci]

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit f733425:

Sandbox	Source
userEvent-PR-template	Configuration

[codecov]

Codecov Report

Merging #731 (f733425) into main (a4943d5) will not change coverage.
The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main      #731   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           50        50           
  Lines          946       958   +12     
  Branches       371       385   +14     
=========================================
+ Hits           946       958   +12     

Impacted Files	Coverage Δ
src/utils/misc/hasPointerEvents.ts	100.00% <ø> (ø)
src/click.ts	100.00% <100.00%> (ø)
src/hover.ts	100.00% <100.00%> (ø)
src/select-options.ts	100.00% <100.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a4943d5...f733425. Read the comment docs.

[ph-fritsche]

@jesperorb Would you be so kind to file a PR documenting this flag in https://github.com/testing-library/testing-library-docs/blob/main/docs/ecosystem-user-event.mdx ?

[jesperorb]

@jesperorb Would you be so kind to file a PR documenting this flag in https://github.com/testing-library/testing-library-docs/blob/main/docs/ecosystem-user-event.mdx ?

@ph-fritsche Yes, will do 👍🏽

[github-actions]

🎉 This PR is included in version 13.3.0 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀

[ph-fritsche]

@all-contributors add @jesperorb code

[allcontributors]

@ph-fritsche

I've put up a pull request to add @jesperorb! 🎉