respect elements that are hidden by <details>

[VinceMalone]

What:

stop considering elements hidden by a collapsed <details> element to be visible or focusable, via getTabDestination().

for example, user.tab() should not focus elements hidden by a collapsed details ancestor.

Why:

same reasons for how .toBeVisible works in jest-dom

An element is visible if all the following conditions are met:

• […]
• if <details /> it has the open attribute

given the following code:

<details>
  <button id="hidden"></button>
</details>
<details open>
  <button id="visible"></button>
</details>

button#hidden should not be considered visible, nor should it be focusable, but button#visible should.

Note
the single exception for this is a summary element that is a direct descendant of a details element. the summary element acts as an [always visible] trigger for controlling the expanded state of the details element.

How:

at least for conveniences sake, i copied the same logic from jest-dom for determining if an element should be considered visible when walking the element tree (with one exception: looking for the hidden attribute — this caused an issue that i think might be a bug in that library)

Checklist:

• Documentation
• Tests
• Ready to be merged
  

[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 d510c45:

Sandbox	Source
userEvent-dom	Configuration
userEvent-react	Configuration

[snowystinger]

Thanks for the PR, a few items
If you don't have time or don't recall, no worries, just let me know and I can take it over.

[snowystinger]

these tests are invalid html, a details must have a summary followed by flow content

[snowystinger]

where is visibility collapse tested? I removed that or and every test is passing

[snowystinger]

better to check element.open? you can set a details open with js by doing detailsElement.open = true