Skip to content

An open source design system that's fully customizable and agent ready

TypeScript

fix(TopNav): make collapsed drawer sections inert (#7699)

홍규진6c54bddfb081
diff --git a/.changeset/topnav-drawer-collapsed-inert.md b/.changeset/topnav-drawer-collapsed-inert.md
new file mode 100644
index 0000000000..87b5a77171
--- /dev/null
+++ b/.changeset/topnav-drawer-collapsed-inert.md
@@ -0,0 +1,7 @@
+---
+'@astryxdesign/core': patch
+---
+
+[fix] A collapsed `TopNavMenu` or `TopNavMegaMenu` section in the mobile drawer is now `inert` and hidden from assistive technology, so Tab no longer moves focus onto links that are not shown and screen readers no longer list them under a section announced as collapsed.
+
+@kyu-rong
diff --git a/packages/core/src/TopNav/TopNavMegaMenu.test.tsx b/packages/core/src/TopNav/TopNavMegaMenu.test.tsx
index e95aba4a9e..115d384c67 100644
--- a/packages/core/src/TopNav/TopNavMegaMenu.test.tsx
+++ b/packages/core/src/TopNav/TopNavMegaMenu.test.tsx
@@ -769,6 +769,31 @@ describe('TopNavMegaMenu — drawer mode', () => {
expect(handleClick).toHaveBeenCalledTimes(1);
});
+ it('makes collapsed items inert and hidden from assistive technology', async () => {
+ const user = userEvent.setup();
+ render(
+ <TopNavRenderContext value="drawer">
+ <TopNavMegaMenu
+ label="Products"
+ items={<TopNavMegaMenuItem title="Analytics" href="/analytics" />}
+ />
+ </TopNavRenderContext>,
+ );
+ const trigger = screen.getByRole('button', {name: 'Products'});
+ const region = document.getElementById(
+ trigger.getAttribute('aria-controls') ?? '',
+ );
+
+ expect(region).toHaveAttribute('inert');
+ expect(region).toHaveAttribute('aria-hidden', 'true');
+ expect(screen.queryByRole('link', {name: 'Analytics'})).toBeNull();
+
+ await user.click(trigger);
+ expect(region).not.toHaveAttribute('inert');
+ expect(region).toHaveAttribute('aria-hidden', 'false');
+ expect(screen.getByRole('link', {name: 'Analytics'})).toBeInTheDocument();
+ });
+
it('clips the drawer section only while it is collapsed', async () => {
// The ring paints outside the item, so a permanent clip would cut it off.
const user = userEvent.setup();
diff --git a/packages/core/src/TopNav/TopNavMegaMenu.tsx b/packages/core/src/TopNav/TopNavMegaMenu.tsx
index d147cc3ab5..e3112079f9 100644
--- a/packages/core/src/TopNav/TopNavMegaMenu.tsx
+++ b/packages/core/src/TopNav/TopNavMegaMenu.tsx
@@ -599,6 +599,8 @@ function DrawerMegaMenu({
{/* Animated expand/collapse container */}
<div
id={`${menuId}-items`}
+ aria-hidden={!isExpanded}
+ inert={!isExpanded ? true : undefined}
{...stylex.props(
styles.drawerItems,
isExpanded && styles.drawerItemsExpanded,
diff --git a/packages/core/src/TopNav/TopNavMenu.test.tsx b/packages/core/src/TopNav/TopNavMenu.test.tsx
index 0c86dbc4b9..3502db4ca1 100644
--- a/packages/core/src/TopNav/TopNavMenu.test.tsx
+++ b/packages/core/src/TopNav/TopNavMenu.test.tsx
@@ -233,12 +233,14 @@ describe('TopNavMenu — drawer focus ring', () => {
expectSharedFocusRing(screen.getByRole('button', {name: /Products/}));
});
- it('draws the shared ring on a drawer item', () => {
+ it('draws the shared ring on a drawer item', async () => {
+ const user = userEvent.setup();
render(
<TopNavRenderContext value="drawer">
<TopNavMenu label="Products" items={mockItems} />
</TopNavRenderContext>,
);
+ await user.click(screen.getByRole('button', {name: /Products/}));
expectSharedFocusRing(screen.getByRole('link', {name: /Analytics/}));
});
@@ -262,6 +264,30 @@ describe('TopNavMenu — drawer focus ring', () => {
});
});
+describe('TopNavMenu — drawer collapsed section', () => {
+ it('makes collapsed items inert and hidden from assistive technology', async () => {
+ const user = userEvent.setup();
+ render(
+ <TopNavRenderContext value="drawer">
+ <TopNavMenu label="Products" items={mockItems} />
+ </TopNavRenderContext>,
+ );
+ const trigger = screen.getByRole('button', {name: /Products/});
+ const region = document.getElementById(
+ trigger.getAttribute('aria-controls') ?? '',
+ );
+
+ expect(region).toHaveAttribute('inert');
+ expect(region).toHaveAttribute('aria-hidden', 'true');
+ expect(screen.queryByRole('link', {name: /Analytics/})).toBeNull();
+
+ await user.click(trigger);
+ expect(region).not.toHaveAttribute('inert');
+ expect(region).toHaveAttribute('aria-hidden', 'false');
+ expect(screen.getByRole('link', {name: /Analytics/})).toBeInTheDocument();
+ });
+});
+
describe('TopNavMenu pass-through props', () => {
it('forwards pass-through props to the trigger button', () => {
render(
diff --git a/packages/core/src/TopNav/TopNavMenu.tsx b/packages/core/src/TopNav/TopNavMenu.tsx
index b3a54f6e8a..060c0ba910 100644
--- a/packages/core/src/TopNav/TopNavMenu.tsx
+++ b/packages/core/src/TopNav/TopNavMenu.tsx
@@ -494,6 +494,8 @@ export function TopNavMenu({
</button>
<div
id={`${menuId}-items`}
+ aria-hidden={!drawerExpanded}
+ inert={!drawerExpanded ? true : undefined}
{...stylex.props(
drawerStyles.items,
drawerExpanded && drawerStyles.itemsExpanded,