Merge 2c1f1fa into a58b1a4

primer · Sep 27, 2024 · 7592a60 · 7592a60
2 parents a58b1a4 + 2c1f1fa
commit 7592a60
Show file tree

Hide file tree

Showing 4 changed files with 13 additions and 4 deletions.
diff --git a/.changeset/perfect-fishes-camp.md b/.changeset/perfect-fishes-camp.md
@@ -0,0 +1,5 @@
+---
+"@primer/react": patch
+---
+
+fix(TooltipV2): always add aria-hidden
diff --git a/packages/react/src/TooltipV2/Tooltip.tsx b/packages/react/src/TooltipV2/Tooltip.tsx
@@ -328,8 +328,8 @@ export const Tooltip = React.forwardRef(
             {...rest}
             // Only need tooltip role if the tooltip is a description for supplementary information
             role={type === 'description' ? 'tooltip' : undefined}
-            // stop AT from announcing the tooltip twice when it is a label type because it will be announced with "aria-labelledby"
-            aria-hidden={type === 'label' ? true : undefined}
+            // stop AT from announcing the tooltip twice: when it is a label type it will be announced with "aria-labelledby",when it is a description type it will be announced with "aria-describedby"
+            aria-hidden={true}
             id={tooltipId}
             // mouse leave and enter on the tooltip itself is needed to keep the tooltip open when the mouse is over the tooltip
             onMouseEnter={openTooltip}

diff --git a/packages/react/src/TooltipV2/__tests__/Tooltip.test.tsx b/packages/react/src/TooltipV2/__tests__/Tooltip.test.tsx
@@ -51,6 +51,10 @@ describe('Tooltip', () => {
     const {getByText} = HTMLRender(<TooltipComponent type="label" />)
     expect(getByText('Tooltip text')).toHaveAttribute('aria-hidden', 'true')
   })
+  it('should render aria-hidden on the tooltip element when the tooltip is description type', () => {
+    const {getByText} = HTMLRender(<TooltipComponent type="description" />)
+    expect(getByText('Tooltip text')).toHaveAttribute('aria-hidden', 'true')
+  })
   it('should describe the trigger element by its tooltip when the tooltip type is description (by default)', () => {
     const {getByRole, getByText} = HTMLRender(<TooltipComponent />)
     const triggerEL = getByRole('button')

diff --git a/packages/react/src/__tests__/ActionMenu.test.tsx b/packages/react/src/__tests__/ActionMenu.test.tsx
@@ -401,7 +401,7 @@ describe('ActionMenu', () => {
       button.focus()
     })
 
-    expect(component.getByRole('tooltip')).toBeInTheDocument()
+    expect(component.getByRole('tooltip', {hidden: true})).toBeInTheDocument()
   })
 
   it('should open menu on menu anchor click and it is wrapped with tooltip v2', async () => {
@@ -437,7 +437,7 @@ describe('ActionMenu', () => {
       button.focus()
     })
 
-    expect(component.getByRole('tooltip')).toBeInTheDocument()
+    expect(component.getByRole('tooltip', {hidden: true})).toBeInTheDocument()
   })
 
   it('should pass the "id" prop from ActionMenu.Button to the HTML button', async () => {