From 475b87c6ab194a87217864fe029c987ad21596b6 Mon Sep 17 00:00:00 2001 From: nemo Date: Mon, 16 Nov 2026 09:47:35 +0800 Subject: [PATCH] fix: keep nested details clicks inside the outer disclosure --- .../fix-nested-details-outside-click.md | 5 ++ .../src/Details/__tests__/Details.test.tsx | 55 ++++++++++++++++++- packages/react/src/hooks/useDetails.tsx | 5 +- 3 files changed, 61 insertions(+), 4 deletions(-) create mode 100644 .changeset/fix-nested-details-outside-click.md diff --git a/.changeset/fix-nested-details-outside-click.md b/.changeset/fix-nested-details-outside-click.md new file mode 100644 index 00000000000..bac06d4384d --- /dev/null +++ b/.changeset/fix-nested-details-outside-click.md @@ -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. diff --git a/packages/react/src/Details/__tests__/Details.test.tsx b/packages/react/src/Details/__tests__/Details.test.tsx index 939d4e4b1b5..6f3cad36de1 100644 --- a/packages/react/src/Details/__tests__/Details.test.tsx +++ b/packages/react/src/Details/__tests__/Details.test.tsx @@ -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 '..' @@ -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 ( + <> +
+ Outer summary +
+ Inner summary + +
+
+ + + ) + } + + it('does not treat a click inside nested details as an outside click', async () => { + const onClickOutside = vi.fn() + render() + + 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() + + 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( 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(test summary) diff --git a/packages/react/src/hooks/useDetails.tsx b/packages/react/src/hooks/useDetails.tsx index 37dfc94af56..8bbd1a99612 100644 --- a/packages/react/src/hooks/useDetails.tsx +++ b/packages/react/src/hooks/useDetails.tsx @@ -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)