Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

respect elements that are hidden by <details> #1165

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 22 additions & 3 deletions src/utils/misc/isVisible.ts
@@ -1,18 +1,37 @@
import {getWindow} from './getWindow'

function isAttributeVisible(element: Element, previousElement: Element | null) {
let detailsVisibility

if (previousElement) {
detailsVisibility =
element.nodeName === 'DETAILS' && previousElement.nodeName !== 'SUMMARY'
? element.hasAttribute('open')
: true
} else {
detailsVisibility =
element.nodeName === 'DETAILS' ? element.hasAttribute('open') : true
}

return detailsVisibility
}

export function isVisible(element: Element): boolean {
const window = getWindow(element)

for (
let el: Element | null = element;
let el: Element | null = element, prev: Element | null = null;
el?.ownerDocument;
el = el.parentElement
prev = el, el = el.parentElement
) {
const {display, visibility} = window.getComputedStyle(el)
if (display === 'none') {
return false
}
if (visibility === 'hidden') {
if (visibility === 'hidden' || visibility === 'collapse') {
return false
}
if (!isAttributeVisible(el, prev)) {
return false
}
}
Expand Down
3 changes: 3 additions & 0 deletions tests/utils/focus/getTabDestination.ts
Expand Up @@ -76,6 +76,9 @@ test('exclude hidden elements', () => {
<input hidden />
<input style="visibility: hidden"/>
<input style="display: none"/>
<details>
<button></button>
</details>
`)

assertTabOrder([elA])
Expand Down
12 changes: 12 additions & 0 deletions tests/utils/misc/isVisible.ts
Expand Up @@ -12,6 +12,15 @@ test('check if element is visible', async () => {
<input data-testid="styledDisplayedInput" hidden style="display: block"/>
<div style="display: none"><input data-testid="childInput" /></div>
<input data-testid="styledVisibiliyHiddenInput" style="visibility: hidden">
<details>
<input data-testid="collapsedInput">
</details>
<details open>
<input data-testid="expandedInput">
</details>
<details>
<summary data-testid="summary"></summary>
</details>
`)

expect(isVisible(screen.getByTestId('visibleInput'))).toBe(true)
Expand All @@ -22,4 +31,7 @@ test('check if element is visible', async () => {
expect(isVisible(screen.getByTestId('styledVisibiliyHiddenInput'))).toBe(
false,
)
expect(isVisible(screen.getByTestId('collapsedInput'))).toBe(false)
expect(isVisible(screen.getByTestId('expandedInput'))).toBe(true)
expect(isVisible(screen.getByTestId('summary'))).toBe(true)
})