Skip to content
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-nested-details-outside-click.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@primer/react': patch
---

Fix `useDetails` treating clicks inside nested details elements as outside clicks. Interacting with nested content no longer closes the outer details element or calls its outside-click handler.
55 changes: 54 additions & 1 deletion packages/react/src/Details/__tests__/Details.test.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import {describe, expect, it} from 'vitest'
import {describe, expect, it, vi} from 'vitest'
import {render} from '@testing-library/react'
import {page, userEvent} from 'vitest/browser'
import Details from '..'
Expand Down Expand Up @@ -93,6 +93,59 @@ describe('Details', () => {
await expect.element(page.getByTestId('summary')).toHaveTextContent('Open')
})

function NestedDetails({
closeOnOutsideClick = true,
onClickOutside,
}: {
closeOnOutsideClick?: boolean
onClickOutside?: (event: MouseEvent) => void
}) {
const {getDetailsProps} = useDetails({defaultOpen: true, closeOnOutsideClick, onClickOutside})
return (
<>
<Details {...getDetailsProps()} data-testid="outer-details">
<Details.Summary>Outer summary</Details.Summary>
<details open data-testid="inner-details">
<summary>Inner summary</summary>
<button type="button">Inner action</button>
</details>
</Details>
<button type="button">Outside action</button>
</>
)
}

it('does not treat a click inside nested details as an outside click', async () => {
const onClickOutside = vi.fn()
render(<NestedDetails onClickOutside={onClickOutside} />)

await page.getByRole('button', {name: 'Inner action'}).click()

expect(onClickOutside).not.toHaveBeenCalled()
await expect.element(page.getByTestId('outer-details')).toHaveAttribute('open')

await page.getByRole('button', {name: 'Outside action'}).click()
expect(onClickOutside).toHaveBeenCalledTimes(1)
await expect.element(page.getByTestId('outer-details')).not.toHaveAttribute('open')
})

it('does not synchronize the outer open state with a nested toggle', async () => {
render(<NestedDetails closeOnOutsideClick={false} />)

await page.getByText('Inner summary', {exact: true}).click()

await expect.element(page.getByTestId('inner-details')).not.toHaveAttribute('open')
await expect.element(page.getByTestId('outer-details')).toHaveAttribute('open')
})

it('allows an outside-click handler to prevent closing', async () => {
render(<NestedDetails onClickOutside={event => event.preventDefault()} />)

await page.getByRole('button', {name: 'Outside action'}).click()

await expect.element(page.getByTestId('outer-details')).toHaveAttribute('open')
})

describe('Details.Summary', () => {
it('should support a custom `className` on the container element', async () => {
render(<Details.Summary className="custom-class">test summary</Details.Summary>)
Expand Down
5 changes: 2 additions & 3 deletions packages/react/src/hooks/useDetails.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,8 @@ function useDetails({ref, closeOnOutsideClick, defaultOpen, onClickOutside}: Use
const onClickOutsideInternal = useCallback(
(event: MouseEvent) => {
const {current} = customRef
const eventTarget = event.target as HTMLElement
const closest = eventTarget.closest('details')
if (closest !== current) {
const eventTarget = event.target as Node | null
if (!current?.contains(eventTarget)) {
onClickOutside && onClickOutside(event)
if (!event.defaultPrevented) {
setOpen(false)
Expand Down