refactor(VisuallyHidden): update base element from div to span (#4691)

* refactor(VisuallyHidden): use span by default over div * refactor(VisuallyHidden): update base element from div to span * chore: add changesets --------- Co-authored-by: Josh Black <[email protected]>
primer · Jun 27, 2024 · 55e97a9 · 55e97a9
1 parent 546803e
commit 55e97a9
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 6 deletions.
diff --git a/.changeset/thick-jars-count.md b/.changeset/thick-jars-count.md
@@ -0,0 +1,5 @@
+---
+'@primer/react': minor
+---
+
+Update internal VisuallyHidden helper to use a `span` by default over a `div` to support more nesting scenarios by default
diff --git a/packages/react/src/Spinner/Spinner.tsx b/packages/react/src/Spinner/Spinner.tsx
@@ -57,11 +57,7 @@ function Spinner({size: sizeKey = 'medium', srText = 'Loading', 'aria-label': ar
           vectorEffect="non-scaling-stroke"
         />
       </svg>
-      {hasHiddenLabel ? (
-        <VisuallyHidden as="span" id={labelId}>
-          {srText}
-        </VisuallyHidden>
-      ) : null}
+      {hasHiddenLabel ? <VisuallyHidden id={labelId}>{srText}</VisuallyHidden> : null}
     </Box>
   )
 }

diff --git a/packages/react/src/internal/components/VisuallyHidden.tsx b/packages/react/src/internal/components/VisuallyHidden.tsx
@@ -12,7 +12,7 @@ import sx from '../../sx'
  *
  * @see https://www.scottohara.me/blog/2023/03/21/visually-hidden-hack.html
  */
-export const VisuallyHidden = styled.div<SxProp>`
+export const VisuallyHidden = styled.span<SxProp>`
   &:not(:focus):not(:active):not(:focus-within) {
     clip-path: inset(50%);
     height: 1px;