An open source design system that's fully customizable and agent ready
TypeScript
fix(Popover): a closed popover carries no dialog role or name (#10487)
Cindy Zhangecafbacc891d
diff --git a/.changeset/popover-closed-no-dialog.md b/.changeset/popover-closed-no-dialog.mdnew file mode 100644index 0000000000..4bd069ba1c--- /dev/null+++ b/.changeset/popover-closed-no-dialog.md@@ -0,0 +1,7 @@+---+'@astryxdesign/core': patch+---++[fix] A closed `Popover`, and any `usePopover` composition, no longer leaves a hidden `role="dialog"` with its label in the DOM. The surface stays mounted but carries the dialog role, name and `aria-modal` only while open, so `[role="dialog"]` selectors and tests that include hidden elements find no dialog that is not on screen. The accessibility tree already omitted the hidden surface. Reopening restores them.++@cixzhangdiff --git a/packages/core/src/ComplexSelector/ComplexSelector.test.tsx b/packages/core/src/ComplexSelector/ComplexSelector.test.tsxindex 21112bf997..7d0d91efb3 100644--- a/packages/core/src/ComplexSelector/ComplexSelector.test.tsx+++ b/packages/core/src/ComplexSelector/ComplexSelector.test.tsx@@ -439,9 +439,8 @@ describe('ComplexSelector', () => {</ComplexSelector>,);- const popover = screen- .getByRole('dialog', {hidden: true})- .closest('[popover]');+ // Closed, the surface carries no dialog role, so find the layer itself.+ const popover = document.querySelector('[popover]');expect(popover?.getAttribute('style')).toContain('position-area: self-block-end span-self-inline-start',);diff --git a/packages/core/src/Popover/Popover.test.tsx b/packages/core/src/Popover/Popover.test.tsxindex bde7bd237f..7f3ae3236d 100644--- a/packages/core/src/Popover/Popover.test.tsx+++ b/packages/core/src/Popover/Popover.test.tsx@@ -122,6 +122,9 @@ describe('usePopover public return type', () => {}render(<HeadlessPopover />);+ // A direct hook composition gets the same closed semantics: no dialog+ // until it opens.+ expect(screen.queryByRole('dialog', {hidden: true})).toBeNull();fireEvent.click(screen.getByRole('button', {name: 'Open headless'}));const surface = screen.getByRole('dialog', {@@ -189,19 +192,60 @@ describe('Popover', () => {expect(trigger).toHaveAttribute('aria-expanded', 'true');});- it('renders popover content with role=dialog', () => {+ it('renders popover content with role=dialog while open', () => {render(<Popover content={<span>Hello</span>} label="Greeting"><button type="button">Open</button></Popover>,);- // The dialog is inside a popover element — hidden from accessibility tree- // until shown, but still present in the DOM+ fireEvent.click(screen.getByRole('button', {name: 'Open'}));const dialog = screen.getByRole('dialog', {hidden: true});expect(dialog).toBeInTheDocument();expect(dialog).toHaveAttribute('aria-label', 'Greeting');});+ it('carries no dialog role or name while closed, before and after it opens', () => {+ const onOpenChange = vi.fn();+ render(+ <Popover+ content={<span>Hello</span>}+ label="Greeting"+ onOpenChange={onOpenChange}>+ <button type="button">Open</button>+ </Popover>,+ );+ const trigger = screen.getByRole('button', {name: 'Open'});+ const surface = document.querySelector<HTMLElement>('.astryx-popover');+ expect(surface).not.toBeNull();+ expect(screen.queryByRole('dialog', {hidden: true})).toBeNull();+ expect(document.querySelector('[role="dialog"]')).toBeNull();+ expect(surface).not.toHaveAttribute('aria-label');++ fireEvent.click(trigger);+ expect(onOpenChange).toHaveBeenLastCalledWith(true);+ expect(screen.getByRole('dialog', {hidden: true})).toHaveAttribute(+ 'aria-label',+ 'Greeting',+ );++ // Closed again, the surface stays mounted but hidden, with no dialog+ // semantics.+ fireEvent.click(trigger);+ expect(onOpenChange).toHaveBeenLastCalledWith(false);+ expect(surface).toBeInTheDocument();+ expect(screen.queryByRole('dialog', {hidden: true})).toBeNull();+ expect(document.querySelector('[role="dialog"]')).toBeNull();+ expect(surface).not.toHaveAttribute('aria-label');+ expect(surface).not.toHaveAttribute('aria-modal');++ // Reopening restores them.+ fireEvent.click(trigger);+ const reopened = screen.getByRole('dialog', {hidden: true});+ expect(reopened).toBe(surface);+ expect(reopened).toHaveAttribute('aria-label', 'Greeting');+ expect(reopened).toHaveAttribute('aria-modal', 'true');+ });+it('can render a neutral wrapper when content owns its role', () => {render(<Popover@@ -237,6 +281,7 @@ describe('Popover', () => {<button type="button">Open</button></Popover>,);+ fireEvent.click(screen.getByRole('button', {name: 'Open'}));const dialog = screen.getByRole('dialog', {hidden: true});expect(dialog).toBeInTheDocument();@@ -1276,10 +1321,9 @@ describe('Popover', () => {);const view = within(secondDocument.body);const trigger = view.getByRole('button', {name: 'Settings'});- const surface = view.getByRole('dialog', {- name: 'Settings',- hidden: true,- });+ // Closed, the surface has no dialog role, so find it by its target.+ const surface =+ secondDocument.body.querySelector<HTMLElement>('.astryx-popover')!;const first = view.getByRole('button', {name: 'First', hidden: true});return {trigger, surface, first, view};}diff --git a/packages/core/src/Popover/__tests__/PopoverKeyboard.interaction.browser.spec.ts b/packages/core/src/Popover/__tests__/PopoverKeyboard.interaction.browser.spec.tsindex 028263dbfe..2149b8b9be 100644--- a/packages/core/src/Popover/__tests__/PopoverKeyboard.interaction.browser.spec.ts+++ b/packages/core/src/Popover/__tests__/PopoverKeyboard.interaction.browser.spec.ts@@ -111,9 +111,9 @@ async function openPopover(}await driver.tap({x: box.x + box.width / 2, y: box.y + box.height / 2});await expect(trigger).toHaveAttribute('aria-expanded', 'true');- const layer = page.locator('[popover]:has([role="dialog"])').first();+ const layer = page.locator('[popover]:has(.astryx-popover)').first();await waitForRest(layer);- return {surface: layer.locator('[role="dialog"]'), trigger};+ return {surface: layer.locator('.astryx-popover'), trigger};}/**@@ -377,7 +377,7 @@ test('a person who scrolls the capped popover before its field reveal keeps theconst capped = freezePageWhen(page,() => {- const layer = document.querySelector('[popover]:has([role="dialog"])');+ const layer = document.querySelector('[popover]:has(.astryx-popover)');return (layer != null &&getComputedStyle(layer)@@ -439,9 +439,9 @@ test('opened while the keyboard is already up, it opens clear of the keyboard',await expect(trigger).toHaveAttribute('aria-expanded', 'true');await page.waitForTimeout(200);await cdp?.send('Animation.setPlaybackRate', {playbackRate: 1});- const layer = page.locator('[popover]:has([role="dialog"])').first();+ const layer = page.locator('[popover]:has(.astryx-popover)').first();await waitForRest(layer);- const surface = layer.locator('[role="dialog"]');+ const surface = layer.locator('.astryx-popover');const opened = await boxOf(surface);const keyboardTop = opened.innerHeight - COVER;expect(opened.keyboardCap).not.toBe('');@@ -482,9 +482,9 @@ async function firstFrameOpenedWithKeyboardUp(page: Page): Promise<FirstFrame> {const win = window as unknown as {__firstFrame?: FirstFrame};const read = () => {const layer = document.querySelector<HTMLElement>(- '[popover]:has([role="dialog"])',+ '[popover]:has(.astryx-popover)',);- const surface = layer?.querySelector<HTMLElement>('[role="dialog"]');+ const surface = layer?.querySelector<HTMLElement>('.astryx-popover');if (layer?.matches(':popover-open') !== true || surface == null) {requestAnimationFrame(read);return;diff --git a/packages/core/src/Popover/__tests__/PopoverTouchMotion.interaction.browser.spec.ts b/packages/core/src/Popover/__tests__/PopoverTouchMotion.interaction.browser.spec.tsindex 48ae21d26a..12ba5fd04b 100644--- a/packages/core/src/Popover/__tests__/PopoverTouchMotion.interaction.browser.spec.ts+++ b/packages/core/src/Popover/__tests__/PopoverTouchMotion.interaction.browser.spec.ts@@ -127,7 +127,7 @@ async function openDefault(page: Page): Promise<OpenStory> {return {driver,trigger,- layer: page.locator('[popover]:has([role="dialog"])').first(),+ layer: page.locator('[popover]:has(.astryx-popover)').first(),center: {x: triggerBox.x + triggerBox.width / 2,y: triggerBox.y + triggerBox.height / 2,@@ -272,7 +272,7 @@ async function logScaleStarts(page: Page) {* copy, which the dismissal clones from it.*/const LONG_MOTIONS =- '[popover]:has([role="dialog"]) { --duration-medium-min: 1200ms; --duration-exit: 1200ms; }';+ '[popover]:has(.astryx-popover) { --duration-medium-min: 1200ms; --duration-exit: 1200ms; }';/** Where each rendering window starts, ms after its motion starts. */const WINDOW_START_MS = 400;@@ -282,7 +282,7 @@ const MIN_WINDOW_MS = 300;/** The blocked-thread proof's growth: 1.2 s at a constant speed. */const STEADY_GROWTH =- '[popover]:has([role="dialog"]) { --duration-medium-min: 1200ms; --ease-entrance: linear; }';+ '[popover]:has(.astryx-popover) { --duration-medium-min: 1200ms; --ease-entrance: linear; }';/** The page's clock, epoch ms. */async function pageNow(page: Page): Promise<number> {@@ -330,7 +330,7 @@ async function waitPastScaleStart(* `::before` or `::after`. Reading them restyles nothing.*/async function contentPromotions(layer: Locator): Promise<string[]> {- return layer.locator('[role="dialog"]').evaluate(dialog =>+ return layer.locator('.astryx-popover').evaluate(dialog =>Array.from(dialog.querySelectorAll<HTMLElement>('*')).flatMap(element => {const name = element.classList.item(0) ?? element.tagName;return Array.from(element.style)@@ -411,7 +411,7 @@ test.describe('with a mouse (a fine primary pointer)', () => {).toBe(false);await trigger.click();await expect(trigger).toHaveAttribute('aria-expanded', 'true');- const layer = page.locator('[popover]:has([role="dialog"])').first();+ const layer = page.locator('[popover]:has(.astryx-popover)').first();// The layer's own CSS entrance runs; no UIKit scale is set or played.const entrance = await layer.evaluate(element => ({inlineScale: (element as HTMLElement).style.getPropertyValue('scale'),@@ -527,7 +527,7 @@ test('the dismissal shrinks back into the trigger on the theme\u2019s exit token// where it stood, out of the accessibility tree and out of reach.const state = await page.evaluate(() => {const layer = document.querySelector<HTMLElement>(- '[popover]:has([role="dialog"])',+ '[popover]:has(.astryx-popover)',)!;const exitCopy = document.querySelector<HTMLElement>('[data-astryx-popover-exit]',@@ -603,7 +603,7 @@ test('the presentation keeps advancing every frame while the main thread is bloc// important declaration outranks the animation. The scale, composited the// same way, carries the evidence.await page.addStyleTag({- content: '[popover]:has([role="dialog"]) { opacity: 1 !important; }',+ content: '[popover]:has(.astryx-popover) { opacity: 1 !important; }',});// The growth runs 1.2 s at a constant speed here, so a 1 s block lands// inside it on a loaded machine too. The marker is 240 px wide, and its@@ -901,7 +901,7 @@ test('a style read after the opening tap finds no CSS entrance running on the laconst probe = window as unknown as {__entrance?: Promise<string[]>};probe.__entrance = new Promise(resolve => {const look = () => {- const layer = document.querySelector('[popover]:has([role="dialog"])');+ const layer = document.querySelector('[popover]:has(.astryx-popover)');if (layer == null || !layer.matches(':popover-open')) {requestAnimationFrame(look);return;diff --git a/packages/core/src/Popover/usePopover.tsx b/packages/core/src/Popover/usePopover.tsxindex 6462e951fe..c277707e44 100644--- a/packages/core/src/Popover/usePopover.tsx+++ b/packages/core/src/Popover/usePopover.tsx@@ -600,6 +600,7 @@ function usePopoverImplementation(role === 'dialog' && !dialogLabel,);+ const isDialogShown = role === 'dialog' && layer.isOpen;// Wrapped render function that includes surface styles and optional hidden close buttonconst render = useCallback((children: ReactNode, props?: ContextRenderProps): ReactNode => {@@ -616,9 +617,11 @@ function usePopoverImplementation(<LayerDepthProvider><divref={contentRef}- role={role === 'dialog' ? 'dialog' : undefined}- aria-modal={role === 'dialog' && isModal ? true : undefined}- aria-label={role === 'dialog' ? dialogLabel : undefined}+ // A closed surface stays mounted but hidden. It carries no dialog+ // role or name, so selectors find no hidden dialog.+ role={isDialogShown ? 'dialog' : undefined}+ aria-modal={isDialogShown && isModal ? true : undefined}+ aria-label={isDialogShown ? dialogLabel : undefined}tabIndex={role === 'dialog' ? -1 : undefined}{...mergeProps({...surfaceProps, className: surfaceClassName},@@ -662,6 +665,7 @@ function usePopoverImplementation(closeButtonLabel,contentRef,dialogLabel,+ isDialogShown,role,isModal,xstyle,