Correct focus changes based on mouseDown result

[ilyamkin]

Because userEvent.click should simulate real browsers' behavior, we need to take into account the result of each event.

In this particular case if mouseDown event has preventDefault, it should stop focus event.

Here is the source code of Google Chrome Blink for reference (others follow the same convention):
https://chromium.googlesource.com/chromium/blink/+/master/Source/core/input/EventHandler.cpp#972

bool swallowEvent = !dispatchMouseEvent(EventTypeNames::mousedown, mev.innerNode(), m_clickCount, mouseEvent);

dispatchMouseEvent return value means "continue default handling", so swallowEvent is true in case of preventDefault usage.

Just below there is call for focus event which is triggered only if swallowEvent === false

swallowEvent = swallowEvent || handleMouseFocus(MouseEventWithHitTestResults(mouseEvent, hitTestResult), sourceCapabilities);

We heavily rely on this case when developing complex components for the design system with focus management.

Another moment is that we probably should use fireEvent.focus() instead of element.focus() to also understand if onFocus was canceled, but that's for another change (related to scrollbar behavior on focus).

[codecov]

Codecov Report

Merging #192 into master will increase coverage by 0.06%.
The diff coverage is 100%.

@@            Coverage Diff             @@
##           master     #192      +/-   ##
==========================================
+ Coverage   97.05%   97.12%   +0.06%     
==========================================
  Files           1        1              
  Lines         136      139       +3     
  Branches       35       36       +1     
==========================================
+ Hits          132      135       +3     
  Misses          4        4

Impacted Files	Coverage Δ
src/index.js	97.12% <100%> (+0.06%)	⬆️

---

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 9ab5b2b...a8d2a5b. Read the comment docs.

[Gpx]

Thank you for this PR. Do you mind adding some tests for this use-case?

[ilyamkin]

@Gpx Sure thing. Done.

[kentcdodds]

Cool! Thank you :D

[Gpx]

🎉 This PR is included in version 8.0.7 🎉

The release is available on:

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

Your semantic-release bot 📦🚀

[ilyamkin]

@kentcdodds Thanks for merging this. Would you add me via all contributors bot, please? 🙏

[kentcdodds]

My bad. Sorry I forgot

[kentcdodds]

@all-contributors please add @ilyamkin for code and tests

[allcontributors]

@kentcdodds

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