An open source design system that's fully customizable and agent ready
TypeScript
fix(menu): accessible name on menu container + drop misplaced aria-haspopup (menus-13/15) (#3419)
Cindy Zhang9c60d205f7d4
diff --git a/.changeset/menu-accessible-name.md b/.changeset/menu-accessible-name.mdnew file mode 100644index 0000000000..1b12a1ef9d--- /dev/null+++ b/.changeset/menu-accessible-name.md@@ -0,0 +1,6 @@+---+'@astryxdesign/core': patch+---++[fix] DropdownMenu/ContextMenu: the `role="menu"` container now has an accessible name — DropdownMenu names it from the trigger's label, and ContextMenu exposes a `menuLabel` prop (default "Context menu"). ContextMenu also no longer places `aria-haspopup="menu"` on its role-less, non-focusable trigger wrapper, where it conveyed nothing useful to assistive tech (menus-13, menus-15).+@cixzhangdiff --git a/packages/core/src/ContextMenu/ContextMenu.doc.mjs b/packages/core/src/ContextMenu/ContextMenu.doc.mjsindex f24fa8ef11..52d10cf7df 100644--- a/packages/core/src/ContextMenu/ContextMenu.doc.mjs+++ b/packages/core/src/ContextMenu/ContextMenu.doc.mjs@@ -52,6 +52,12 @@ export const docs = {description: 'Size of menu items: controls padding density.',default: "'md'",},+ {+ name: 'label',+ type: 'string',+ description: 'Accessible name for the menu surface, announced when it opens.',+ default: "'Context menu'",+ },{name: 'hasAutoFocus',type: 'boolean',diff --git a/packages/core/src/ContextMenu/ContextMenu.test.tsx b/packages/core/src/ContextMenu/ContextMenu.test.tsxindex 6bdd358afe..763917bbff 100644--- a/packages/core/src/ContextMenu/ContextMenu.test.tsx+++ b/packages/core/src/ContextMenu/ContextMenu.test.tsx@@ -76,6 +76,38 @@ describe('ContextMenu', () => {).toHaveFocus();});+ it('gives the menu an accessible name (menus-13)', () => {+ render(+ <ContextMenu items={[{label: 'Item 1'}]}>+ <div>Right-click me</div>+ </ContextMenu>,+ );+ // Defaults to "Context menu"; overridable via label.+ expect(+ screen.getByRole('menu', {name: 'Context menu', hidden: true}),+ ).toBeInTheDocument();+ });++ it('uses a custom label', () => {+ render(+ <ContextMenu items={[{label: 'Item 1'}]} label="Row actions">+ <div>Right-click me</div>+ </ContextMenu>,+ );+ expect(+ screen.getByRole('menu', {name: 'Row actions', hidden: true}),+ ).toBeInTheDocument();+ });++ it('does not put aria-haspopup on the role-less trigger wrapper (menus-15)', () => {+ render(+ <ContextMenu items={[{label: 'Item 1'}]} data-testid="ctx">+ <div>Right-click me</div>+ </ContextMenu>,+ );+ expect(screen.getByTestId('ctx')).not.toHaveAttribute('aria-haspopup');+ });+it('opens menu on right-click', () => {render(<ContextMenu items={[{label: 'Item 1'}]}>diff --git a/packages/core/src/ContextMenu/ContextMenu.tsx b/packages/core/src/ContextMenu/ContextMenu.tsxindex 85445acdfb..0e85b4c88c 100644--- a/packages/core/src/ContextMenu/ContextMenu.tsx+++ b/packages/core/src/ContextMenu/ContextMenu.tsx@@ -114,6 +114,11 @@ interface ContextMenuBaseProps extends BaseProps {menuWidth?: number | string;/** Size of menu items. @default 'md' */size?: 'sm' | 'md' | 'lg';+ /**+ * Accessible name for the menu surface, announced when it opens.+ * @default 'Context menu'+ */+ label?: string;/*** Whether to auto-focus the first menu item when the menu opens.* Set to `false` for inline showcases or documentation previews.@@ -172,6 +177,7 @@ export function ContextMenu({children,menuWidth,size = 'md',+ label = 'Context menu',hasAutoFocus = true,isDisabled = false,onOpenChange,@@ -348,11 +354,7 @@ export function ContextMenu({return (<>- <div- ref={ref}- onContextMenu={handleContextMenu}- aria-haspopup="menu"- data-testid={testId}>+ <div ref={ref} onContextMenu={handleContextMenu} data-testid={testId}>{children}</div>@@ -361,6 +363,7 @@ export function ContextMenu({ref={listRef}id={menuId}role="menu"+ aria-label={label}onKeyDown={listKeyDown}{...mergeProps(themeProps('context-menu'),diff --git a/packages/core/src/DropdownMenu/DropdownMenu.test.tsx b/packages/core/src/DropdownMenu/DropdownMenu.test.tsxindex f31c3af691..3f8de54dbf 100644--- a/packages/core/src/DropdownMenu/DropdownMenu.test.tsx+++ b/packages/core/src/DropdownMenu/DropdownMenu.test.tsx@@ -57,6 +57,15 @@ describe('DropdownMenu', () => {expect(screen.getByRole('menu', {hidden: true})).toBeInTheDocument();});+ it('names the menu from the trigger label (menus-13)', () => {+ render(+ <DropdownMenu button={{label: 'Actions'}} items={[{label: 'Item 1'}]} />,+ );+ expect(+ screen.getByRole('menu', {name: 'Actions', hidden: true}),+ ).toBeInTheDocument();+ });+it('does not wrap the menu in a role="dialog" aria-modal element', () => {render(<DropdownMenu button={{label: 'Actions'}} items={[{label: 'Item 1'}]} />,diff --git a/packages/core/src/DropdownMenu/DropdownMenu.tsx b/packages/core/src/DropdownMenu/DropdownMenu.tsxindex 6ea01ddc36..25f9b08b4c 100644--- a/packages/core/src/DropdownMenu/DropdownMenu.tsx+++ b/packages/core/src/DropdownMenu/DropdownMenu.tsx@@ -441,6 +441,10 @@ export function DropdownMenu({ref={listRef}id={menuId}role="menu"+ // Give the menu an accessible name from its trigger's label, so+ // screen readers announce e.g. "Actions menu" rather than an unnamed+ // menu (menus-13).+ aria-label={button.label}onKeyDown={listKeyDown}{...mergeProps(themeProps('dropdown-menu'),