Skip to content

refactor(ui): Menu interaction and accessibility improvements#8333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
alexcarpenter merged 5 commits into from
Jun 18, 2026
Merged

refactor(ui): Menu interaction and accessibility improvements #8333

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b7bbb60
refactor(ui): Menu interaction and accessibility improvements
alexcarpenter Apr 16, 2026
8fc7015
fix tests
alexcarpenter Apr 16, 2026
9fdec33
Create menu-keyboard-a11y.md
alexcarpenter Apr 16, 2026
b29716c
add disabled test case
alexcarpenter Apr 16, 2026
8d4b8cc
Merge branch 'main' into carp/menu-interaction-improvements
alexcarpenter Jun 18, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/menu-keyboard-a11y.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Menu keyboard navigation and accessibility. Menus now support `Enter`/`Space` to open from the trigger, `ArrowDown`/`ArrowUp`/`Home`/`End` to move focus, `Escape` to close and return focus to the trigger, and skip disabled items during arrow-key navigation. Menus no longer mark the rest of the page as `aria-hidden` while open, so assistive technologies can still reach surrounding content.
23 changes: 22 additions & 1 deletion packages/ui/src/components/UserProfile/__tests__/ConnectedAccountsSection.test.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,32 @@
import { CLERK_MODAL_STATE } from '@clerk/shared/internal/clerk-js/constants';
import type { ExternalAccountResource } from '@clerk/shared/types';
import { act, waitFor } from '@testing-library/react';
import type { ComponentType, PropsWithChildren } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render, screen } from '@/test/utils';

import { AppearanceProvider } from '../../../customizables';
import { ConnectedAccountsSection } from '../ConnectedAccountsSection';

// jsdom never fires CSS `animationend`/`transitionend` events, so
// `@formkit/auto-animate` (used by ProfileSection.ItemList) can never complete
// its exit animation and retains unmounted DOM nodes indefinitely. This
// prevents tests from deterministically asserting that a subtree was removed
// after a state change. Disabling animations via appearance options makes the
// Animated wrapper a no-op so React's unmount is reflected in the DOM
// synchronously. The real-browser animation path is covered by manual testing
// and by `Collapsible.test.tsx`.
const withAnimationsDisabled = (Wrapper: ComponentType<PropsWithChildren>) => {
const WithAnimationsDisabled = ({ children }: PropsWithChildren) => (
<Wrapper>
<AppearanceProvider appearance={{ options: { animations: false } }}>{children}</AppearanceProvider>
</Wrapper>
);
return WithAnimationsDisabled;
};

const { createFixtures } = bindCreateFixtures('UserProfile');

const withoutConnections = createFixtures.config(f => {
Expand DownExpand Up@@ -374,7 +393,9 @@ describe('ConnectedAccountsSection ', () => {
describe('Handles opening/closing actions', () => {
it('closes remove account form when connect account action is clicked', async () => {
const { wrapper } = await createFixtures(withSomeConnections);
const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, { wrapper });
const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, {
wrapper: withAnimationsDisabled(wrapper),
});

const item = getByText(/google/i);
const menuButton = item.parentElement?.parentElement?.parentElement?.parentElement?.children?.[1];
Expand Down
190 changes: 99 additions & 91 deletions packages/ui/src/elements/Menu.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import {
FloatingList,
useClick,
useInteractions,
useListItem,
useListNavigation,
useMergeRefs,
useRole,
} from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useRef } from 'react';

import { useMergeRefs } from '@floating-ui/react';

import type { Button } from '../customizables';
import { Col, descriptors, SimpleButton } from '../customizables';
import type { UsePopoverReturn } from '../hooks';
Expand All@@ -16,9 +23,16 @@ import { colors } from '../utils/colors';
import { withFloatingTree } from './contexts';
import { Popover } from './Popover';

type UseInteractionsReturn = ReturnType<typeof useInteractions>;

type MenuState = {
popoverCtx: UsePopoverReturn;
elementId?: MenuId;
getReferenceProps: UseInteractionsReturn['getReferenceProps'];
getFloatingProps: UseInteractionsReturn['getFloatingProps'];
getItemProps: UseInteractionsReturn['getItemProps'];
activeIndex: number | null;
elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
};

export const [MenuStateCtx, useMenuState] = createContextAndHook<MenuState>('MenuState');
Expand All@@ -35,8 +49,41 @@ export const Menu = withFloatingTree((props: MenuProps) => {
offset: 8,
shoudFlip: true,
});
const { context, isOpen } = popoverCtx;

const [activeIndex, setActiveIndex] = React.useState<number | null>(null);
const elementsRef = useRef<Array<HTMLElement | null>>([]);

const value = React.useMemo(() => ({ value: { popoverCtx, elementId } }), [{ ...popoverCtx }, elementId]);
React.useEffect(() => {
if (!isOpen) {
setActiveIndex(null);
}
}, [isOpen]);

const click = useClick(context);
const role = useRole(context, { role: 'menu' });
const listNavigation = useListNavigation(context, {
listRef: elementsRef,
activeIndex,
onNavigate: setActiveIndex,
loop: true,
});
const { getReferenceProps, getFloatingProps, getItemProps } = useInteractions([click, role, listNavigation]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.

const value = React.useMemo(
() => ({
value: {
popoverCtx,
elementId,
getReferenceProps,
getFloatingProps,
getItemProps,
activeIndex,
elementsRef,
},
}),
[popoverCtx, elementId, getReferenceProps, getFloatingProps, getItemProps, activeIndex],
);

return (
<MenuStateCtx.Provider
Expand All@@ -50,8 +97,8 @@ type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: b

export const MenuTrigger = (props: MenuTriggerProps) => {
const { children, ariaLabel } = props;
const { popoverCtx, elementId } = useMenuState();
const { reference, toggle, isOpen } = popoverCtx;
const { popoverCtx, elementId, getReferenceProps } = useMenuState();
const { reference, isOpen } = popoverCtx;

const normalizedAriaLabel = typeof ariaLabel === 'function' ? ariaLabel(isOpen) : ariaLabel;

Expand All@@ -64,86 +111,60 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
elementDescriptor: children.props.elementDescriptor || descriptors.menuButton,
elementId: children.props.elementId || descriptors.menuButton.setId(elementId),
'aria-label': normalizedAriaLabel,
'aria-expanded': isOpen,
'aria-haspopup': 'menu',
onClick: (e: React.MouseEvent) => {
children.props?.onClick?.(e);
toggle();
},
...getReferenceProps({
onClick: children.props?.onClick,
}),
});
};

const findMenuItem = (el: Element, siblingType: 'prev' | 'next', options?: { countSelf?: boolean }) => {
let tagName = options?.countSelf ? el.tagName : '';
let sibling: Element | null = el;
while (sibling && tagName.toUpperCase() !== 'BUTTON') {
sibling = sibling[siblingType === 'prev' ? 'previousElementSibling' : 'nextElementSibling'];
tagName = sibling?.tagName ?? '';
}
return sibling;
};

type MenuListProps = PropsOfComponent<typeof Col> & {
asPortal?: boolean;
};

export const MenuList = (props: MenuListProps) => {
const { sx, asPortal, ...rest } = props;
const { popoverCtx, elementId } = useMenuState();
const { popoverCtx, elementId, getFloatingProps, elementsRef } = useMenuState();
const { floating, styles, isOpen, context, nodeId } = popoverCtx;
const containerRef = useRef<HTMLDivElement | null>(null);
const mergedRef = useMergeRefs([containerRef, floating]);

const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
const current = containerRef.current;
if (!current) {
return;
}

if (current !== document.activeElement) {
return;
}

if (e.key === 'ArrowDown') {
e.preventDefault();
return (findMenuItem(current.children[0], 'next', { countSelf: true }) as HTMLElement)?.focus();
}
};

return (
<Popover
context={context}
nodeId={nodeId}
isOpen={isOpen}
portal={asPortal}
order={['content']}
modal={false}
>
<Col
elementDescriptor={descriptors.menuList}
elementId={descriptors.menuList.setId(elementId)}
ref={mergedRef}
role='menu'
onKeyDown={onKeyDown}
sx={[
t => ({
backgroundColor: colors.makeSolid(t.colors.$colorBackground),
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$solid,
borderColor: t.colors.$borderAlpha150,
outline: 'none',
borderRadius: t.radii.$md,
padding: t.space.$0x5,
overflow: 'hidden',
top: `calc(100% + ${t.space.$2})`,
animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
transformOrigin: 'top center',
zIndex: t.zIndices.$dropdown,
gap: t.space.$0x5,
}),
sx,
]}
style={styles}
{...rest}
/>
<FloatingList elementsRef={elementsRef}>
<Col
elementDescriptor={descriptors.menuList}
elementId={descriptors.menuList.setId(elementId)}
ref={mergedRef}
sx={[
t => ({
backgroundColor: colors.makeSolid(t.colors.$colorBackground),
borderWidth: t.borderWidths.$normal,
borderStyle: t.borderStyles.$solid,
borderColor: t.colors.$borderAlpha150,
outline: 'none',
borderRadius: t.radii.$md,
padding: t.space.$0x5,
overflow: 'hidden',
top: `calc(100% + ${t.space.$2})`,
animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
transformOrigin: 'top center',
zIndex: t.zIndices.$dropdown,
gap: t.space.$0x5,
}),
sx,
]}
style={styles}
{...getFloatingProps()}
{...rest}
/>
</FloatingList>
</Popover>
);
};
Expand All@@ -155,43 +176,30 @@ type MenuItemProps = PropsOfComponent<typeof Button> & {

export const MenuItem = (props: MenuItemProps) => {
const { sx, onClick, destructive, closeAfterClick = true, ...rest } = props;
const { popoverCtx, elementId } = useMenuState();
const { popoverCtx, elementId, getItemProps, activeIndex } = useMenuState();
const { toggle } = popoverCtx;
const buttonRef = useRef<HTMLButtonElement>(null);

const onKeyDown = (e: React.KeyboardEvent<HTMLButtonElement>) => {
const current = buttonRef.current;
if (!current) {
return;
}

const key = e.key;
if (key !== 'ArrowUp' && key !== 'ArrowDown') {
return;
}

e.preventDefault();
const sibling = findMenuItem(current, key === 'ArrowUp' ? 'prev' : 'next');
(sibling as HTMLElement)?.focus();
};
const item = useListItem();
const isActive = item.index === activeIndex;

return (
<SimpleButton
ref={buttonRef}
ref={item.ref}
elementDescriptor={descriptors.menuItem}
elementId={descriptors.menuItem.setId(elementId)}
hoverAsFocus
variant='ghost'
colorScheme={destructive ? 'danger' : 'neutral'}
role='menuitem'
onKeyDown={onKeyDown}
tabIndex={isActive ? 0 : -1}
focusRing={false}
onClick={e => {
onClick?.(e);
if (closeAfterClick) {
toggle();
}
}}
{...getItemProps({
onClick: (e: React.MouseEvent<HTMLButtonElement>) => {
onClick?.(e);
if (closeAfterClick) {
toggle();
}
},
})}
sx={[
theme => ({
justifyContent: 'start',
Expand Down
10 changes: 10 additions & 0 deletions packages/ui/src/elements/Popover.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,13 @@ type PopoverProps = PropsWithChildren<{
*/
outsideElementsInert?: boolean;
order?: Array<'reference' | 'floating' | 'content'>;
/**
* Whether focus is trapped inside the floating element and outside elements
* are marked `aria-hidden`. Dialogs should be `true`; menus / dropdowns should
* be `false` so the trigger remains in the accessibility tree.
* @default true
*/
modal?: boolean;
portal?: boolean;
/**
* The root element to render the portal into.
Expand All@@ -29,6 +36,7 @@ export const Popover = (props: PopoverProps) => {
initialFocus,
outsideElementsInert = false,
order = ['reference', 'content'],
modal = true,
nodeId,
isOpen,
portal = true,
Expand All@@ -49,6 +57,7 @@ export const Popover = (props: PopoverProps) => {
initialFocus={initialFocus}
outsideElementsInert={outsideElementsInert}
order={order}
modal={modal}
>
<>{children}</>
</FloatingFocusManager>
Expand All@@ -65,6 +74,7 @@ export const Popover = (props: PopoverProps) => {
context={context}
initialFocus={initialFocus}
order={order}
modal={modal}
>
<>{children}</>
</FloatingFocusManager>
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/elements/ThreeDotsMenu.tsx
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

return (
<Menu elementId={elementId}>
<MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<MenuTrigger ariaLabel={(isOpen: boolean) => `${isOpen ? 'Close' : 'Open'} menu`}>
<Button
sx={t =>
!isBordered
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
refactor(ui): Menu interaction and accessibility improvements by alexcarpenter · Pull Request #8333 · clerk/javascript · GitHub
Skip to content
refactor(ui): Menu interaction and accessibility improvements#8333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 5 commits into

from

Jun 18, 2026
 Merged


refactor(ui): Menu interaction and accessibility improvements
#8333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b7bbb60

refactor(ui): Menu interaction and accessibility improvements


alexcarpenter Apr 16, 2026
8fc7015

fix tests


alexcarpenter Apr 16, 2026
9fdec33

Create menu-keyboard-a11y.md


alexcarpenter Apr 16, 2026
b29716c

add disabled test case


alexcarpenter Apr 16, 2026
8d4b8cc

Merge branch 'main' into carp/menu-interaction-improvements


alexcarpenter Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/menu-keyboard-a11y.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Menu keyboard navigation and accessibility. Menus now support `Enter`/`Space` to open from the trigger, `ArrowDown`/`ArrowUp`/`Home`/`End` to move focus, `Escape` to close and return focus to the trigger, and skip disabled items during arrow-key navigation. Menus no longer mark the rest of the page as `aria-hidden` while open, so assistive technologies can still reach surrounding content.

23 changes: 22 additions & 1 deletion
packages/ui/src/components/UserProfile/__tests__/ConnectedAccountsSection.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,32 @@
import { CLERK_MODAL_STATE } from '@clerk/shared/internal/clerk-js/constants';
import type { ExternalAccountResource } from '@clerk/shared/types';
import { act, waitFor } from '@testing-library/react';
import type { ComponentType, PropsWithChildren } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render, screen } from '@/test/utils';

import { AppearanceProvider } from '../../../customizables';
import { ConnectedAccountsSection } from '../ConnectedAccountsSection';

// jsdom never fires CSS `animationend`/`transitionend` events, so
// `@formkit/auto-animate` (used by ProfileSection.ItemList) can never complete
// its exit animation and retains unmounted DOM nodes indefinitely. This
// prevents tests from deterministically asserting that a subtree was removed
// after a state change. Disabling animations via appearance options makes the
// Animated wrapper a no-op so React's unmount is reflected in the DOM
// synchronously. The real-browser animation path is covered by manual testing
// and by `Collapsible.test.tsx`.
const withAnimationsDisabled = (Wrapper: ComponentType<PropsWithChildren>) => {
 const WithAnimationsDisabled = ({ children }: PropsWithChildren) => (
 <Wrapper>
 <AppearanceProvider appearance={{ options: { animations: false } }}>{children}</AppearanceProvider>
 </Wrapper>
 );
 return WithAnimationsDisabled;
};

const { createFixtures } = bindCreateFixtures('UserProfile');

const withoutConnections = createFixtures.config(f => {
Expand DownExpand Up@@ -374,7 +393,9 @@ describe('ConnectedAccountsSection ', () => {
 describe('Handles opening/closing actions', () => {
 it('closes remove account form when connect account action is clicked', async () => {
 const { wrapper } = await createFixtures(withSomeConnections);
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, { wrapper });
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, {
 wrapper: withAnimationsDisabled(wrapper),
 });

 const item = getByText(/google/i);
 const menuButton = item.parentElement?.parentElement?.parentElement?.parentElement?.children?.[1];
Expand Down

190 changes: 99 additions & 91 deletions
packages/ui/src/elements/Menu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import {
 FloatingList,
 useClick,
 useInteractions,
 useListItem,
 useListNavigation,
 useMergeRefs,
 useRole,
} from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useRef } from 'react';

import { useMergeRefs } from '@floating-ui/react';

import type { Button } from '../customizables';
import { Col, descriptors, SimpleButton } from '../customizables';
import type { UsePopoverReturn } from '../hooks';
Expand All@@ -16,9 +23,16 @@ import { colors } from '../utils/colors';
import { withFloatingTree } from './contexts';
import { Popover } from './Popover';

type UseInteractionsReturn = ReturnType<typeof useInteractions>;

type MenuState = {
 popoverCtx: UsePopoverReturn;
 elementId?: MenuId;
 getReferenceProps: UseInteractionsReturn['getReferenceProps'];
 getFloatingProps: UseInteractionsReturn['getFloatingProps'];
 getItemProps: UseInteractionsReturn['getItemProps'];
 activeIndex: number | null;
 elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
};

export const [MenuStateCtx, useMenuState] = createContextAndHook<MenuState>('MenuState');
Expand All@@ -35,8 +49,41 @@ export const Menu = withFloatingTree((props: MenuProps) => {
 offset: 8,
 shoudFlip: true,
 });
 const { context, isOpen } = popoverCtx;

 const [activeIndex, setActiveIndex] = React.useState<number | null>(null);
 const elementsRef = useRef<Array<HTMLElement | null>>([]);

 const value = React.useMemo(() => ({ value: { popoverCtx, elementId } }), [{ ...popoverCtx }, elementId]);
 React.useEffect(() => {
 if (!isOpen) {
 setActiveIndex(null);
 }
 }, [isOpen]);

 const click = useClick(context);
 const role = useRole(context, { role: 'menu' });
 const listNavigation = useListNavigation(context, {
 listRef: elementsRef,
 activeIndex,
 onNavigate: setActiveIndex,
 loop: true,
 });
 const { getReferenceProps, getFloatingProps, getItemProps } = useInteractions([click, role, listNavigation]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.


 const value = React.useMemo(
 () => ({
 value: {
 popoverCtx,
 elementId,
 getReferenceProps,
 getFloatingProps,
 getItemProps,
 activeIndex,
 elementsRef,
 },
 }),
 [popoverCtx, elementId, getReferenceProps, getFloatingProps, getItemProps, activeIndex],
 );

 return (
 <MenuStateCtx.Provider
Expand All@@ -50,8 +97,8 @@ type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: b

export const MenuTrigger = (props: MenuTriggerProps) => {
 const { children, ariaLabel } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { reference, toggle, isOpen } = popoverCtx;
 const { popoverCtx, elementId, getReferenceProps } = useMenuState();
 const { reference, isOpen } = popoverCtx;

 const normalizedAriaLabel = typeof ariaLabel === 'function' ? ariaLabel(isOpen) : ariaLabel;

Expand All@@ -64,86 +111,60 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
 elementDescriptor: children.props.elementDescriptor || descriptors.menuButton,
 elementId: children.props.elementId || descriptors.menuButton.setId(elementId),
 'aria-label': normalizedAriaLabel,
 'aria-expanded': isOpen,
 'aria-haspopup': 'menu',
 onClick: (e: React.MouseEvent) => {
 children.props?.onClick?.(e);
 toggle();
 },
 ...getReferenceProps({
 onClick: children.props?.onClick,
 }),
 });
};

const findMenuItem = (el: Element, siblingType: 'prev' | 'next', options?: { countSelf?: boolean }) => {
 let tagName = options?.countSelf ? el.tagName : '';
 let sibling: Element | null = el;
 while (sibling && tagName.toUpperCase() !== 'BUTTON') {
 sibling = sibling[siblingType === 'prev' ? 'previousElementSibling' : 'nextElementSibling'];
 tagName = sibling?.tagName ?? '';
 }
 return sibling;
};

type MenuListProps = PropsOfComponent<typeof Col> & {
 asPortal?: boolean;
};

export const MenuList = (props: MenuListProps) => {
 const { sx, asPortal, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getFloatingProps, elementsRef } = useMenuState();
 const { floating, styles, isOpen, context, nodeId } = popoverCtx;
 const containerRef = useRef<HTMLDivElement | null>(null);
 const mergedRef = useMergeRefs([containerRef, floating]);

 const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
 const current = containerRef.current;
 if (!current) {
 return;
 }

 if (current !== document.activeElement) {
 return;
 }

 if (e.key === 'ArrowDown') {
 e.preventDefault();
 return (findMenuItem(current.children[0], 'next', { countSelf: true }) as HTMLElement)?.focus();
 }
 };

 return (
 <Popover
 context={context}
 nodeId={nodeId}
 isOpen={isOpen}
 portal={asPortal}
 order={['content']}
 modal={false}
 >
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 role='menu'
 onKeyDown={onKeyDown}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...rest}
 />
 <FloatingList elementsRef={elementsRef}>
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...getFloatingProps()}
 {...rest}
 />
 </FloatingList>
 </Popover>
 );
};
Expand All@@ -155,43 +176,30 @@ type MenuItemProps = PropsOfComponent<typeof Button> & {

export const MenuItem = (props: MenuItemProps) => {
 const { sx, onClick, destructive, closeAfterClick = true, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getItemProps, activeIndex } = useMenuState();
 const { toggle } = popoverCtx;
 const buttonRef = useRef<HTMLButtonElement>(null);

 const onKeyDown = (e: React.KeyboardEvent<HTMLButtonElement>) => {
 const current = buttonRef.current;
 if (!current) {
 return;
 }

 const key = e.key;
 if (key !== 'ArrowUp' && key !== 'ArrowDown') {
 return;
 }

 e.preventDefault();
 const sibling = findMenuItem(current, key === 'ArrowUp' ? 'prev' : 'next');
 (sibling as HTMLElement)?.focus();
 };
 const item = useListItem();
 const isActive = item.index === activeIndex;

 return (
 <SimpleButton
 ref={buttonRef}
 ref={item.ref}
 elementDescriptor={descriptors.menuItem}
 elementId={descriptors.menuItem.setId(elementId)}
 hoverAsFocus
 variant='ghost'
 colorScheme={destructive ? 'danger' : 'neutral'}
 role='menuitem'
onKeyDown={onKeyDown}
tabIndex={isActive ? 0 : -1}
 focusRing={false}
 onClick={e => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 }}
 {...getItemProps({
 onClick: (e: React.MouseEvent<HTMLButtonElement>) => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 },
 })}
 sx={[
 theme => ({
 justifyContent: 'start',
Expand Down

10 changes: 10 additions & 0 deletions
packages/ui/src/elements/Popover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,13 @@ type PopoverProps = PropsWithChildren<{
 */
 outsideElementsInert?: boolean;
 order?: Array<'reference' | 'floating' | 'content'>;
 /**
 * Whether focus is trapped inside the floating element and outside elements
 * are marked `aria-hidden`. Dialogs should be `true`; menus / dropdowns should
 * be `false` so the trigger remains in the accessibility tree.
 * @default true
 */
 modal?: boolean;
 portal?: boolean;
 /**
 * The root element to render the portal into.
Expand All@@ -29,6 +36,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus,
 outsideElementsInert = false,
 order = ['reference', 'content'],
 modal = true,
 nodeId,
 isOpen,
 portal = true,
Expand All@@ -49,6 +57,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus={initialFocus}
 outsideElementsInert={outsideElementsInert}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand All@@ -65,6 +74,7 @@ export const Popover = (props: PopoverProps) => {
 context={context}
 initialFocus={initialFocus}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand Down

2 changes: 1 addition & 1 deletion
packages/ui/src/elements/ThreeDotsMenu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

 return (
 <Menu elementId={elementId}>
 <MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
 <MenuTrigger ariaLabel={(isOpen: boolean) => `${isOpen ? 'Close' : 'Open'} menu`}>
 <Button
 sx={t =>
 !isBordered
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
refactor(ui): Menu interaction and accessibility improvements by alexcarpenter · Pull Request #8333 · clerk/javascript · GitHub
Skip to content
refactor(ui): Menu interaction and accessibility improvements#8333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 5 commits into

from

Jun 18, 2026
 Merged


refactor(ui): Menu interaction and accessibility improvements
#8333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b7bbb60

refactor(ui): Menu interaction and accessibility improvements


alexcarpenter Apr 16, 2026
8fc7015

fix tests


alexcarpenter Apr 16, 2026
9fdec33

Create menu-keyboard-a11y.md


alexcarpenter Apr 16, 2026
b29716c

add disabled test case


alexcarpenter Apr 16, 2026
8d4b8cc

Merge branch 'main' into carp/menu-interaction-improvements


alexcarpenter Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/menu-keyboard-a11y.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Menu keyboard navigation and accessibility. Menus now support `Enter`/`Space` to open from the trigger, `ArrowDown`/`ArrowUp`/`Home`/`End` to move focus, `Escape` to close and return focus to the trigger, and skip disabled items during arrow-key navigation. Menus no longer mark the rest of the page as `aria-hidden` while open, so assistive technologies can still reach surrounding content.

23 changes: 22 additions & 1 deletion
packages/ui/src/components/UserProfile/__tests__/ConnectedAccountsSection.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,32 @@
import { CLERK_MODAL_STATE } from '@clerk/shared/internal/clerk-js/constants';
import type { ExternalAccountResource } from '@clerk/shared/types';
import { act, waitFor } from '@testing-library/react';
import type { ComponentType, PropsWithChildren } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render, screen } from '@/test/utils';

import { AppearanceProvider } from '../../../customizables';
import { ConnectedAccountsSection } from '../ConnectedAccountsSection';

// jsdom never fires CSS `animationend`/`transitionend` events, so
// `@formkit/auto-animate` (used by ProfileSection.ItemList) can never complete
// its exit animation and retains unmounted DOM nodes indefinitely. This
// prevents tests from deterministically asserting that a subtree was removed
// after a state change. Disabling animations via appearance options makes the
// Animated wrapper a no-op so React's unmount is reflected in the DOM
// synchronously. The real-browser animation path is covered by manual testing
// and by `Collapsible.test.tsx`.
const withAnimationsDisabled = (Wrapper: ComponentType<PropsWithChildren>) => {
 const WithAnimationsDisabled = ({ children }: PropsWithChildren) => (
 <Wrapper>
 <AppearanceProvider appearance={{ options: { animations: false } }}>{children}</AppearanceProvider>
 </Wrapper>
 );
 return WithAnimationsDisabled;
};

const { createFixtures } = bindCreateFixtures('UserProfile');

const withoutConnections = createFixtures.config(f => {
Expand DownExpand Up@@ -374,7 +393,9 @@ describe('ConnectedAccountsSection ', () => {
 describe('Handles opening/closing actions', () => {
 it('closes remove account form when connect account action is clicked', async () => {
 const { wrapper } = await createFixtures(withSomeConnections);
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, { wrapper });
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, {
 wrapper: withAnimationsDisabled(wrapper),
 });

 const item = getByText(/google/i);
 const menuButton = item.parentElement?.parentElement?.parentElement?.parentElement?.children?.[1];
Expand Down

190 changes: 99 additions & 91 deletions
packages/ui/src/elements/Menu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import {
 FloatingList,
 useClick,
 useInteractions,
 useListItem,
 useListNavigation,
 useMergeRefs,
 useRole,
} from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useRef } from 'react';

import { useMergeRefs } from '@floating-ui/react';

import type { Button } from '../customizables';
import { Col, descriptors, SimpleButton } from '../customizables';
import type { UsePopoverReturn } from '../hooks';
Expand All@@ -16,9 +23,16 @@ import { colors } from '../utils/colors';
import { withFloatingTree } from './contexts';
import { Popover } from './Popover';

type UseInteractionsReturn = ReturnType<typeof useInteractions>;

type MenuState = {
 popoverCtx: UsePopoverReturn;
 elementId?: MenuId;
 getReferenceProps: UseInteractionsReturn['getReferenceProps'];
 getFloatingProps: UseInteractionsReturn['getFloatingProps'];
 getItemProps: UseInteractionsReturn['getItemProps'];
 activeIndex: number | null;
 elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
};

export const [MenuStateCtx, useMenuState] = createContextAndHook<MenuState>('MenuState');
Expand All@@ -35,8 +49,41 @@ export const Menu = withFloatingTree((props: MenuProps) => {
 offset: 8,
 shoudFlip: true,
 });
 const { context, isOpen } = popoverCtx;

 const [activeIndex, setActiveIndex] = React.useState<number | null>(null);
 const elementsRef = useRef<Array<HTMLElement | null>>([]);

 const value = React.useMemo(() => ({ value: { popoverCtx, elementId } }), [{ ...popoverCtx }, elementId]);
 React.useEffect(() => {
 if (!isOpen) {
 setActiveIndex(null);
 }
 }, [isOpen]);

 const click = useClick(context);
 const role = useRole(context, { role: 'menu' });
 const listNavigation = useListNavigation(context, {
 listRef: elementsRef,
 activeIndex,
 onNavigate: setActiveIndex,
 loop: true,
 });
 const { getReferenceProps, getFloatingProps, getItemProps } = useInteractions([click, role, listNavigation]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.


 const value = React.useMemo(
 () => ({
 value: {
 popoverCtx,
 elementId,
 getReferenceProps,
 getFloatingProps,
 getItemProps,
 activeIndex,
 elementsRef,
 },
 }),
 [popoverCtx, elementId, getReferenceProps, getFloatingProps, getItemProps, activeIndex],
 );

 return (
 <MenuStateCtx.Provider
Expand All@@ -50,8 +97,8 @@ type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: b

export const MenuTrigger = (props: MenuTriggerProps) => {
 const { children, ariaLabel } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { reference, toggle, isOpen } = popoverCtx;
 const { popoverCtx, elementId, getReferenceProps } = useMenuState();
 const { reference, isOpen } = popoverCtx;

 const normalizedAriaLabel = typeof ariaLabel === 'function' ? ariaLabel(isOpen) : ariaLabel;

Expand All@@ -64,86 +111,60 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
 elementDescriptor: children.props.elementDescriptor || descriptors.menuButton,
 elementId: children.props.elementId || descriptors.menuButton.setId(elementId),
 'aria-label': normalizedAriaLabel,
 'aria-expanded': isOpen,
 'aria-haspopup': 'menu',
 onClick: (e: React.MouseEvent) => {
 children.props?.onClick?.(e);
 toggle();
 },
 ...getReferenceProps({
 onClick: children.props?.onClick,
 }),
 });
};

const findMenuItem = (el: Element, siblingType: 'prev' | 'next', options?: { countSelf?: boolean }) => {
 let tagName = options?.countSelf ? el.tagName : '';
 let sibling: Element | null = el;
 while (sibling && tagName.toUpperCase() !== 'BUTTON') {
 sibling = sibling[siblingType === 'prev' ? 'previousElementSibling' : 'nextElementSibling'];
 tagName = sibling?.tagName ?? '';
 }
 return sibling;
};

type MenuListProps = PropsOfComponent<typeof Col> & {
 asPortal?: boolean;
};

export const MenuList = (props: MenuListProps) => {
 const { sx, asPortal, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getFloatingProps, elementsRef } = useMenuState();
 const { floating, styles, isOpen, context, nodeId } = popoverCtx;
 const containerRef = useRef<HTMLDivElement | null>(null);
 const mergedRef = useMergeRefs([containerRef, floating]);

 const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
 const current = containerRef.current;
 if (!current) {
 return;
 }

 if (current !== document.activeElement) {
 return;
 }

 if (e.key === 'ArrowDown') {
 e.preventDefault();
 return (findMenuItem(current.children[0], 'next', { countSelf: true }) as HTMLElement)?.focus();
 }
 };

 return (
 <Popover
 context={context}
 nodeId={nodeId}
 isOpen={isOpen}
 portal={asPortal}
 order={['content']}
 modal={false}
 >
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 role='menu'
 onKeyDown={onKeyDown}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...rest}
 />
 <FloatingList elementsRef={elementsRef}>
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...getFloatingProps()}
 {...rest}
 />
 </FloatingList>
 </Popover>
 );
};
Expand All@@ -155,43 +176,30 @@ type MenuItemProps = PropsOfComponent<typeof Button> & {

export const MenuItem = (props: MenuItemProps) => {
 const { sx, onClick, destructive, closeAfterClick = true, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getItemProps, activeIndex } = useMenuState();
 const { toggle } = popoverCtx;
 const buttonRef = useRef<HTMLButtonElement>(null);

 const onKeyDown = (e: React.KeyboardEvent<HTMLButtonElement>) => {
 const current = buttonRef.current;
 if (!current) {
 return;
 }

 const key = e.key;
 if (key !== 'ArrowUp' && key !== 'ArrowDown') {
 return;
 }

 e.preventDefault();
 const sibling = findMenuItem(current, key === 'ArrowUp' ? 'prev' : 'next');
 (sibling as HTMLElement)?.focus();
 };
 const item = useListItem();
 const isActive = item.index === activeIndex;

 return (
 <SimpleButton
 ref={buttonRef}
 ref={item.ref}
 elementDescriptor={descriptors.menuItem}
 elementId={descriptors.menuItem.setId(elementId)}
 hoverAsFocus
 variant='ghost'
 colorScheme={destructive ? 'danger' : 'neutral'}
 role='menuitem'
onKeyDown={onKeyDown}
tabIndex={isActive ? 0 : -1}
 focusRing={false}
 onClick={e => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 }}
 {...getItemProps({
 onClick: (e: React.MouseEvent<HTMLButtonElement>) => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 },
 })}
 sx={[
 theme => ({
 justifyContent: 'start',
Expand Down

10 changes: 10 additions & 0 deletions
packages/ui/src/elements/Popover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,13 @@ type PopoverProps = PropsWithChildren<{
 */
 outsideElementsInert?: boolean;
 order?: Array<'reference' | 'floating' | 'content'>;
 /**
 * Whether focus is trapped inside the floating element and outside elements
 * are marked `aria-hidden`. Dialogs should be `true`; menus / dropdowns should
 * be `false` so the trigger remains in the accessibility tree.
 * @default true
 */
 modal?: boolean;
 portal?: boolean;
 /**
 * The root element to render the portal into.
Expand All@@ -29,6 +36,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus,
 outsideElementsInert = false,
 order = ['reference', 'content'],
 modal = true,
 nodeId,
 isOpen,
 portal = true,
Expand All@@ -49,6 +57,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus={initialFocus}
 outsideElementsInert={outsideElementsInert}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand All@@ -65,6 +74,7 @@ export const Popover = (props: PopoverProps) => {
 context={context}
 initialFocus={initialFocus}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand Down

2 changes: 1 addition & 1 deletion
packages/ui/src/elements/ThreeDotsMenu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

 return (
 <Menu elementId={elementId}>
 <MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
 <MenuTrigger ariaLabel={(isOpen: boolean) => `${isOpen ? 'Close' : 'Open'} menu`}>
 <Button
 sx={t =>
 !isBordered
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
refactor(ui): Menu interaction and accessibility improvements by alexcarpenter · Pull Request #8333 · clerk/javascript · GitHub
Skip to content
refactor(ui): Menu interaction and accessibility improvements#8333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 5 commits into

from

Jun 18, 2026
 Merged


refactor(ui): Menu interaction and accessibility improvements
#8333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b7bbb60

refactor(ui): Menu interaction and accessibility improvements


alexcarpenter Apr 16, 2026
8fc7015

fix tests


alexcarpenter Apr 16, 2026
9fdec33

Create menu-keyboard-a11y.md


alexcarpenter Apr 16, 2026
b29716c

add disabled test case


alexcarpenter Apr 16, 2026
8d4b8cc

Merge branch 'main' into carp/menu-interaction-improvements


alexcarpenter Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/menu-keyboard-a11y.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Menu keyboard navigation and accessibility. Menus now support `Enter`/`Space` to open from the trigger, `ArrowDown`/`ArrowUp`/`Home`/`End` to move focus, `Escape` to close and return focus to the trigger, and skip disabled items during arrow-key navigation. Menus no longer mark the rest of the page as `aria-hidden` while open, so assistive technologies can still reach surrounding content.

23 changes: 22 additions & 1 deletion
packages/ui/src/components/UserProfile/__tests__/ConnectedAccountsSection.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,32 @@
import { CLERK_MODAL_STATE } from '@clerk/shared/internal/clerk-js/constants';
import type { ExternalAccountResource } from '@clerk/shared/types';
import { act, waitFor } from '@testing-library/react';
import type { ComponentType, PropsWithChildren } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render, screen } from '@/test/utils';

import { AppearanceProvider } from '../../../customizables';
import { ConnectedAccountsSection } from '../ConnectedAccountsSection';

// jsdom never fires CSS `animationend`/`transitionend` events, so
// `@formkit/auto-animate` (used by ProfileSection.ItemList) can never complete
// its exit animation and retains unmounted DOM nodes indefinitely. This
// prevents tests from deterministically asserting that a subtree was removed
// after a state change. Disabling animations via appearance options makes the
// Animated wrapper a no-op so React's unmount is reflected in the DOM
// synchronously. The real-browser animation path is covered by manual testing
// and by `Collapsible.test.tsx`.
const withAnimationsDisabled = (Wrapper: ComponentType<PropsWithChildren>) => {
 const WithAnimationsDisabled = ({ children }: PropsWithChildren) => (
 <Wrapper>
 <AppearanceProvider appearance={{ options: { animations: false } }}>{children}</AppearanceProvider>
 </Wrapper>
 );
 return WithAnimationsDisabled;
};

const { createFixtures } = bindCreateFixtures('UserProfile');

const withoutConnections = createFixtures.config(f => {
Expand DownExpand Up@@ -374,7 +393,9 @@ describe('ConnectedAccountsSection ', () => {
 describe('Handles opening/closing actions', () => {
 it('closes remove account form when connect account action is clicked', async () => {
 const { wrapper } = await createFixtures(withSomeConnections);
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, { wrapper });
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, {
 wrapper: withAnimationsDisabled(wrapper),
 });

 const item = getByText(/google/i);
 const menuButton = item.parentElement?.parentElement?.parentElement?.parentElement?.children?.[1];
Expand Down

190 changes: 99 additions & 91 deletions
packages/ui/src/elements/Menu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import {
 FloatingList,
 useClick,
 useInteractions,
 useListItem,
 useListNavigation,
 useMergeRefs,
 useRole,
} from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useRef } from 'react';

import { useMergeRefs } from '@floating-ui/react';

import type { Button } from '../customizables';
import { Col, descriptors, SimpleButton } from '../customizables';
import type { UsePopoverReturn } from '../hooks';
Expand All@@ -16,9 +23,16 @@ import { colors } from '../utils/colors';
import { withFloatingTree } from './contexts';
import { Popover } from './Popover';

type UseInteractionsReturn = ReturnType<typeof useInteractions>;

type MenuState = {
 popoverCtx: UsePopoverReturn;
 elementId?: MenuId;
 getReferenceProps: UseInteractionsReturn['getReferenceProps'];
 getFloatingProps: UseInteractionsReturn['getFloatingProps'];
 getItemProps: UseInteractionsReturn['getItemProps'];
 activeIndex: number | null;
 elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
};

export const [MenuStateCtx, useMenuState] = createContextAndHook<MenuState>('MenuState');
Expand All@@ -35,8 +49,41 @@ export const Menu = withFloatingTree((props: MenuProps) => {
 offset: 8,
 shoudFlip: true,
 });
 const { context, isOpen } = popoverCtx;

 const [activeIndex, setActiveIndex] = React.useState<number | null>(null);
 const elementsRef = useRef<Array<HTMLElement | null>>([]);

 const value = React.useMemo(() => ({ value: { popoverCtx, elementId } }), [{ ...popoverCtx }, elementId]);
 React.useEffect(() => {
 if (!isOpen) {
 setActiveIndex(null);
 }
 }, [isOpen]);

 const click = useClick(context);
 const role = useRole(context, { role: 'menu' });
 const listNavigation = useListNavigation(context, {
 listRef: elementsRef,
 activeIndex,
 onNavigate: setActiveIndex,
 loop: true,
 });
 const { getReferenceProps, getFloatingProps, getItemProps } = useInteractions([click, role, listNavigation]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.


 const value = React.useMemo(
 () => ({
 value: {
 popoverCtx,
 elementId,
 getReferenceProps,
 getFloatingProps,
 getItemProps,
 activeIndex,
 elementsRef,
 },
 }),
 [popoverCtx, elementId, getReferenceProps, getFloatingProps, getItemProps, activeIndex],
 );

 return (
 <MenuStateCtx.Provider
Expand All@@ -50,8 +97,8 @@ type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: b

export const MenuTrigger = (props: MenuTriggerProps) => {
 const { children, ariaLabel } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { reference, toggle, isOpen } = popoverCtx;
 const { popoverCtx, elementId, getReferenceProps } = useMenuState();
 const { reference, isOpen } = popoverCtx;

 const normalizedAriaLabel = typeof ariaLabel === 'function' ? ariaLabel(isOpen) : ariaLabel;

Expand All@@ -64,86 +111,60 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
 elementDescriptor: children.props.elementDescriptor || descriptors.menuButton,
 elementId: children.props.elementId || descriptors.menuButton.setId(elementId),
 'aria-label': normalizedAriaLabel,
 'aria-expanded': isOpen,
 'aria-haspopup': 'menu',
 onClick: (e: React.MouseEvent) => {
 children.props?.onClick?.(e);
 toggle();
 },
 ...getReferenceProps({
 onClick: children.props?.onClick,
 }),
 });
};

const findMenuItem = (el: Element, siblingType: 'prev' | 'next', options?: { countSelf?: boolean }) => {
 let tagName = options?.countSelf ? el.tagName : '';
 let sibling: Element | null = el;
 while (sibling && tagName.toUpperCase() !== 'BUTTON') {
 sibling = sibling[siblingType === 'prev' ? 'previousElementSibling' : 'nextElementSibling'];
 tagName = sibling?.tagName ?? '';
 }
 return sibling;
};

type MenuListProps = PropsOfComponent<typeof Col> & {
 asPortal?: boolean;
};

export const MenuList = (props: MenuListProps) => {
 const { sx, asPortal, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getFloatingProps, elementsRef } = useMenuState();
 const { floating, styles, isOpen, context, nodeId } = popoverCtx;
 const containerRef = useRef<HTMLDivElement | null>(null);
 const mergedRef = useMergeRefs([containerRef, floating]);

 const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
 const current = containerRef.current;
 if (!current) {
 return;
 }

 if (current !== document.activeElement) {
 return;
 }

 if (e.key === 'ArrowDown') {
 e.preventDefault();
 return (findMenuItem(current.children[0], 'next', { countSelf: true }) as HTMLElement)?.focus();
 }
 };

 return (
 <Popover
 context={context}
 nodeId={nodeId}
 isOpen={isOpen}
 portal={asPortal}
 order={['content']}
 modal={false}
 >
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 role='menu'
 onKeyDown={onKeyDown}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...rest}
 />
 <FloatingList elementsRef={elementsRef}>
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...getFloatingProps()}
 {...rest}
 />
 </FloatingList>
 </Popover>
 );
};
Expand All@@ -155,43 +176,30 @@ type MenuItemProps = PropsOfComponent<typeof Button> & {

export const MenuItem = (props: MenuItemProps) => {
 const { sx, onClick, destructive, closeAfterClick = true, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getItemProps, activeIndex } = useMenuState();
 const { toggle } = popoverCtx;
 const buttonRef = useRef<HTMLButtonElement>(null);

 const onKeyDown = (e: React.KeyboardEvent<HTMLButtonElement>) => {
 const current = buttonRef.current;
 if (!current) {
 return;
 }

 const key = e.key;
 if (key !== 'ArrowUp' && key !== 'ArrowDown') {
 return;
 }

 e.preventDefault();
 const sibling = findMenuItem(current, key === 'ArrowUp' ? 'prev' : 'next');
 (sibling as HTMLElement)?.focus();
 };
 const item = useListItem();
 const isActive = item.index === activeIndex;

 return (
 <SimpleButton
 ref={buttonRef}
 ref={item.ref}
 elementDescriptor={descriptors.menuItem}
 elementId={descriptors.menuItem.setId(elementId)}
 hoverAsFocus
 variant='ghost'
 colorScheme={destructive ? 'danger' : 'neutral'}
 role='menuitem'
onKeyDown={onKeyDown}
tabIndex={isActive ? 0 : -1}
 focusRing={false}
 onClick={e => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 }}
 {...getItemProps({
 onClick: (e: React.MouseEvent<HTMLButtonElement>) => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 },
 })}
 sx={[
 theme => ({
 justifyContent: 'start',
Expand Down

10 changes: 10 additions & 0 deletions
packages/ui/src/elements/Popover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,13 @@ type PopoverProps = PropsWithChildren<{
 */
 outsideElementsInert?: boolean;
 order?: Array<'reference' | 'floating' | 'content'>;
 /**
 * Whether focus is trapped inside the floating element and outside elements
 * are marked `aria-hidden`. Dialogs should be `true`; menus / dropdowns should
 * be `false` so the trigger remains in the accessibility tree.
 * @default true
 */
 modal?: boolean;
 portal?: boolean;
 /**
 * The root element to render the portal into.
Expand All@@ -29,6 +36,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus,
 outsideElementsInert = false,
 order = ['reference', 'content'],
 modal = true,
 nodeId,
 isOpen,
 portal = true,
Expand All@@ -49,6 +57,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus={initialFocus}
 outsideElementsInert={outsideElementsInert}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand All@@ -65,6 +74,7 @@ export const Popover = (props: PopoverProps) => {
 context={context}
 initialFocus={initialFocus}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand Down

2 changes: 1 addition & 1 deletion
packages/ui/src/elements/ThreeDotsMenu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

 return (
 <Menu elementId={elementId}>
 <MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
 <MenuTrigger ariaLabel={(isOpen: boolean) => `${isOpen ? 'Close' : 'Open'} menu`}>
 <Button
 sx={t =>
 !isBordered
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
refactor(ui): Menu interaction and accessibility improvements by alexcarpenter · Pull Request #8333 · clerk/javascript · GitHub
Skip to content
refactor(ui): Menu interaction and accessibility improvements#8333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 5 commits into

from

Jun 18, 2026
 Merged


refactor(ui): Menu interaction and accessibility improvements
#8333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b7bbb60

refactor(ui): Menu interaction and accessibility improvements


alexcarpenter Apr 16, 2026
8fc7015

fix tests


alexcarpenter Apr 16, 2026
9fdec33

Create menu-keyboard-a11y.md


alexcarpenter Apr 16, 2026
b29716c

add disabled test case


alexcarpenter Apr 16, 2026
8d4b8cc

Merge branch 'main' into carp/menu-interaction-improvements


alexcarpenter Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/menu-keyboard-a11y.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Menu keyboard navigation and accessibility. Menus now support `Enter`/`Space` to open from the trigger, `ArrowDown`/`ArrowUp`/`Home`/`End` to move focus, `Escape` to close and return focus to the trigger, and skip disabled items during arrow-key navigation. Menus no longer mark the rest of the page as `aria-hidden` while open, so assistive technologies can still reach surrounding content.

23 changes: 22 additions & 1 deletion
packages/ui/src/components/UserProfile/__tests__/ConnectedAccountsSection.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,32 @@
import { CLERK_MODAL_STATE } from '@clerk/shared/internal/clerk-js/constants';
import type { ExternalAccountResource } from '@clerk/shared/types';
import { act, waitFor } from '@testing-library/react';
import type { ComponentType, PropsWithChildren } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render, screen } from '@/test/utils';

import { AppearanceProvider } from '../../../customizables';
import { ConnectedAccountsSection } from '../ConnectedAccountsSection';

// jsdom never fires CSS `animationend`/`transitionend` events, so
// `@formkit/auto-animate` (used by ProfileSection.ItemList) can never complete
// its exit animation and retains unmounted DOM nodes indefinitely. This
// prevents tests from deterministically asserting that a subtree was removed
// after a state change. Disabling animations via appearance options makes the
// Animated wrapper a no-op so React's unmount is reflected in the DOM
// synchronously. The real-browser animation path is covered by manual testing
// and by `Collapsible.test.tsx`.
const withAnimationsDisabled = (Wrapper: ComponentType<PropsWithChildren>) => {
 const WithAnimationsDisabled = ({ children }: PropsWithChildren) => (
 <Wrapper>
 <AppearanceProvider appearance={{ options: { animations: false } }}>{children}</AppearanceProvider>
 </Wrapper>
 );
 return WithAnimationsDisabled;
};

const { createFixtures } = bindCreateFixtures('UserProfile');

const withoutConnections = createFixtures.config(f => {
Expand DownExpand Up@@ -374,7 +393,9 @@ describe('ConnectedAccountsSection ', () => {
 describe('Handles opening/closing actions', () => {
 it('closes remove account form when connect account action is clicked', async () => {
 const { wrapper } = await createFixtures(withSomeConnections);
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, { wrapper });
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, {
 wrapper: withAnimationsDisabled(wrapper),
 });

 const item = getByText(/google/i);
 const menuButton = item.parentElement?.parentElement?.parentElement?.parentElement?.children?.[1];
Expand Down

190 changes: 99 additions & 91 deletions
packages/ui/src/elements/Menu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import {
 FloatingList,
 useClick,
 useInteractions,
 useListItem,
 useListNavigation,
 useMergeRefs,
 useRole,
} from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useRef } from 'react';

import { useMergeRefs } from '@floating-ui/react';

import type { Button } from '../customizables';
import { Col, descriptors, SimpleButton } from '../customizables';
import type { UsePopoverReturn } from '../hooks';
Expand All@@ -16,9 +23,16 @@ import { colors } from '../utils/colors';
import { withFloatingTree } from './contexts';
import { Popover } from './Popover';

type UseInteractionsReturn = ReturnType<typeof useInteractions>;

type MenuState = {
 popoverCtx: UsePopoverReturn;
 elementId?: MenuId;
 getReferenceProps: UseInteractionsReturn['getReferenceProps'];
 getFloatingProps: UseInteractionsReturn['getFloatingProps'];
 getItemProps: UseInteractionsReturn['getItemProps'];
 activeIndex: number | null;
 elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
};

export const [MenuStateCtx, useMenuState] = createContextAndHook<MenuState>('MenuState');
Expand All@@ -35,8 +49,41 @@ export const Menu = withFloatingTree((props: MenuProps) => {
 offset: 8,
 shoudFlip: true,
 });
 const { context, isOpen } = popoverCtx;

 const [activeIndex, setActiveIndex] = React.useState<number | null>(null);
 const elementsRef = useRef<Array<HTMLElement | null>>([]);

 const value = React.useMemo(() => ({ value: { popoverCtx, elementId } }), [{ ...popoverCtx }, elementId]);
 React.useEffect(() => {
 if (!isOpen) {
 setActiveIndex(null);
 }
 }, [isOpen]);

 const click = useClick(context);
 const role = useRole(context, { role: 'menu' });
 const listNavigation = useListNavigation(context, {
 listRef: elementsRef,
 activeIndex,
 onNavigate: setActiveIndex,
 loop: true,
 });
 const { getReferenceProps, getFloatingProps, getItemProps } = useInteractions([click, role, listNavigation]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.


 const value = React.useMemo(
 () => ({
 value: {
 popoverCtx,
 elementId,
 getReferenceProps,
 getFloatingProps,
 getItemProps,
 activeIndex,
 elementsRef,
 },
 }),
 [popoverCtx, elementId, getReferenceProps, getFloatingProps, getItemProps, activeIndex],
 );

 return (
 <MenuStateCtx.Provider
Expand All@@ -50,8 +97,8 @@ type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: b

export const MenuTrigger = (props: MenuTriggerProps) => {
 const { children, ariaLabel } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { reference, toggle, isOpen } = popoverCtx;
 const { popoverCtx, elementId, getReferenceProps } = useMenuState();
 const { reference, isOpen } = popoverCtx;

 const normalizedAriaLabel = typeof ariaLabel === 'function' ? ariaLabel(isOpen) : ariaLabel;

Expand All@@ -64,86 +111,60 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
 elementDescriptor: children.props.elementDescriptor || descriptors.menuButton,
 elementId: children.props.elementId || descriptors.menuButton.setId(elementId),
 'aria-label': normalizedAriaLabel,
 'aria-expanded': isOpen,
 'aria-haspopup': 'menu',
 onClick: (e: React.MouseEvent) => {
 children.props?.onClick?.(e);
 toggle();
 },
 ...getReferenceProps({
 onClick: children.props?.onClick,
 }),
 });
};

const findMenuItem = (el: Element, siblingType: 'prev' | 'next', options?: { countSelf?: boolean }) => {
 let tagName = options?.countSelf ? el.tagName : '';
 let sibling: Element | null = el;
 while (sibling && tagName.toUpperCase() !== 'BUTTON') {
 sibling = sibling[siblingType === 'prev' ? 'previousElementSibling' : 'nextElementSibling'];
 tagName = sibling?.tagName ?? '';
 }
 return sibling;
};

type MenuListProps = PropsOfComponent<typeof Col> & {
 asPortal?: boolean;
};

export const MenuList = (props: MenuListProps) => {
 const { sx, asPortal, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getFloatingProps, elementsRef } = useMenuState();
 const { floating, styles, isOpen, context, nodeId } = popoverCtx;
 const containerRef = useRef<HTMLDivElement | null>(null);
 const mergedRef = useMergeRefs([containerRef, floating]);

 const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
 const current = containerRef.current;
 if (!current) {
 return;
 }

 if (current !== document.activeElement) {
 return;
 }

 if (e.key === 'ArrowDown') {
 e.preventDefault();
 return (findMenuItem(current.children[0], 'next', { countSelf: true }) as HTMLElement)?.focus();
 }
 };

 return (
 <Popover
 context={context}
 nodeId={nodeId}
 isOpen={isOpen}
 portal={asPortal}
 order={['content']}
 modal={false}
 >
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 role='menu'
 onKeyDown={onKeyDown}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...rest}
 />
 <FloatingList elementsRef={elementsRef}>
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...getFloatingProps()}
 {...rest}
 />
 </FloatingList>
 </Popover>
 );
};
Expand All@@ -155,43 +176,30 @@ type MenuItemProps = PropsOfComponent<typeof Button> & {

export const MenuItem = (props: MenuItemProps) => {
 const { sx, onClick, destructive, closeAfterClick = true, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getItemProps, activeIndex } = useMenuState();
 const { toggle } = popoverCtx;
 const buttonRef = useRef<HTMLButtonElement>(null);

 const onKeyDown = (e: React.KeyboardEvent<HTMLButtonElement>) => {
 const current = buttonRef.current;
 if (!current) {
 return;
 }

 const key = e.key;
 if (key !== 'ArrowUp' && key !== 'ArrowDown') {
 return;
 }

 e.preventDefault();
 const sibling = findMenuItem(current, key === 'ArrowUp' ? 'prev' : 'next');
 (sibling as HTMLElement)?.focus();
 };
 const item = useListItem();
 const isActive = item.index === activeIndex;

 return (
 <SimpleButton
 ref={buttonRef}
 ref={item.ref}
 elementDescriptor={descriptors.menuItem}
 elementId={descriptors.menuItem.setId(elementId)}
 hoverAsFocus
 variant='ghost'
 colorScheme={destructive ? 'danger' : 'neutral'}
 role='menuitem'
onKeyDown={onKeyDown}
tabIndex={isActive ? 0 : -1}
 focusRing={false}
 onClick={e => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 }}
 {...getItemProps({
 onClick: (e: React.MouseEvent<HTMLButtonElement>) => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 },
 })}
 sx={[
 theme => ({
 justifyContent: 'start',
Expand Down

10 changes: 10 additions & 0 deletions
packages/ui/src/elements/Popover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,13 @@ type PopoverProps = PropsWithChildren<{
 */
 outsideElementsInert?: boolean;
 order?: Array<'reference' | 'floating' | 'content'>;
 /**
 * Whether focus is trapped inside the floating element and outside elements
 * are marked `aria-hidden`. Dialogs should be `true`; menus / dropdowns should
 * be `false` so the trigger remains in the accessibility tree.
 * @default true
 */
 modal?: boolean;
 portal?: boolean;
 /**
 * The root element to render the portal into.
Expand All@@ -29,6 +36,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus,
 outsideElementsInert = false,
 order = ['reference', 'content'],
 modal = true,
 nodeId,
 isOpen,
 portal = true,
Expand All@@ -49,6 +57,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus={initialFocus}
 outsideElementsInert={outsideElementsInert}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand All@@ -65,6 +74,7 @@ export const Popover = (props: PopoverProps) => {
 context={context}
 initialFocus={initialFocus}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand Down

2 changes: 1 addition & 1 deletion
packages/ui/src/elements/ThreeDotsMenu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

 return (
 <Menu elementId={elementId}>
 <MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
 <MenuTrigger ariaLabel={(isOpen: boolean) => `${isOpen ? 'Close' : 'Open'} menu`}>
 <Button
 sx={t =>
 !isBordered
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
refactor(ui): Menu interaction and accessibility improvements by alexcarpenter · Pull Request #8333 · clerk/javascript · GitHub
Skip to content
refactor(ui): Menu interaction and accessibility improvements#8333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 5 commits into

from

Jun 18, 2026
 Merged


refactor(ui): Menu interaction and accessibility improvements
#8333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b7bbb60

refactor(ui): Menu interaction and accessibility improvements


alexcarpenter Apr 16, 2026
8fc7015

fix tests


alexcarpenter Apr 16, 2026
9fdec33

Create menu-keyboard-a11y.md


alexcarpenter Apr 16, 2026
b29716c

add disabled test case


alexcarpenter Apr 16, 2026
8d4b8cc

Merge branch 'main' into carp/menu-interaction-improvements


alexcarpenter Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/menu-keyboard-a11y.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Menu keyboard navigation and accessibility. Menus now support `Enter`/`Space` to open from the trigger, `ArrowDown`/`ArrowUp`/`Home`/`End` to move focus, `Escape` to close and return focus to the trigger, and skip disabled items during arrow-key navigation. Menus no longer mark the rest of the page as `aria-hidden` while open, so assistive technologies can still reach surrounding content.

23 changes: 22 additions & 1 deletion
packages/ui/src/components/UserProfile/__tests__/ConnectedAccountsSection.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,32 @@
import { CLERK_MODAL_STATE } from '@clerk/shared/internal/clerk-js/constants';
import type { ExternalAccountResource } from '@clerk/shared/types';
import { act, waitFor } from '@testing-library/react';
import type { ComponentType, PropsWithChildren } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render, screen } from '@/test/utils';

import { AppearanceProvider } from '../../../customizables';
import { ConnectedAccountsSection } from '../ConnectedAccountsSection';

// jsdom never fires CSS `animationend`/`transitionend` events, so
// `@formkit/auto-animate` (used by ProfileSection.ItemList) can never complete
// its exit animation and retains unmounted DOM nodes indefinitely. This
// prevents tests from deterministically asserting that a subtree was removed
// after a state change. Disabling animations via appearance options makes the
// Animated wrapper a no-op so React's unmount is reflected in the DOM
// synchronously. The real-browser animation path is covered by manual testing
// and by `Collapsible.test.tsx`.
const withAnimationsDisabled = (Wrapper: ComponentType<PropsWithChildren>) => {
 const WithAnimationsDisabled = ({ children }: PropsWithChildren) => (
 <Wrapper>
 <AppearanceProvider appearance={{ options: { animations: false } }}>{children}</AppearanceProvider>
 </Wrapper>
 );
 return WithAnimationsDisabled;
};

const { createFixtures } = bindCreateFixtures('UserProfile');

const withoutConnections = createFixtures.config(f => {
Expand DownExpand Up@@ -374,7 +393,9 @@ describe('ConnectedAccountsSection ', () => {
 describe('Handles opening/closing actions', () => {
 it('closes remove account form when connect account action is clicked', async () => {
 const { wrapper } = await createFixtures(withSomeConnections);
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, { wrapper });
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, {
 wrapper: withAnimationsDisabled(wrapper),
 });

 const item = getByText(/google/i);
 const menuButton = item.parentElement?.parentElement?.parentElement?.parentElement?.children?.[1];
Expand Down

190 changes: 99 additions & 91 deletions
packages/ui/src/elements/Menu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import {
 FloatingList,
 useClick,
 useInteractions,
 useListItem,
 useListNavigation,
 useMergeRefs,
 useRole,
} from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useRef } from 'react';

import { useMergeRefs } from '@floating-ui/react';

import type { Button } from '../customizables';
import { Col, descriptors, SimpleButton } from '../customizables';
import type { UsePopoverReturn } from '../hooks';
Expand All@@ -16,9 +23,16 @@ import { colors } from '../utils/colors';
import { withFloatingTree } from './contexts';
import { Popover } from './Popover';

type UseInteractionsReturn = ReturnType<typeof useInteractions>;

type MenuState = {
 popoverCtx: UsePopoverReturn;
 elementId?: MenuId;
 getReferenceProps: UseInteractionsReturn['getReferenceProps'];
 getFloatingProps: UseInteractionsReturn['getFloatingProps'];
 getItemProps: UseInteractionsReturn['getItemProps'];
 activeIndex: number | null;
 elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
};

export const [MenuStateCtx, useMenuState] = createContextAndHook<MenuState>('MenuState');
Expand All@@ -35,8 +49,41 @@ export const Menu = withFloatingTree((props: MenuProps) => {
 offset: 8,
 shoudFlip: true,
 });
 const { context, isOpen } = popoverCtx;

 const [activeIndex, setActiveIndex] = React.useState<number | null>(null);
 const elementsRef = useRef<Array<HTMLElement | null>>([]);

 const value = React.useMemo(() => ({ value: { popoverCtx, elementId } }), [{ ...popoverCtx }, elementId]);
 React.useEffect(() => {
 if (!isOpen) {
 setActiveIndex(null);
 }
 }, [isOpen]);

 const click = useClick(context);
 const role = useRole(context, { role: 'menu' });
 const listNavigation = useListNavigation(context, {
 listRef: elementsRef,
 activeIndex,
 onNavigate: setActiveIndex,
 loop: true,
 });
 const { getReferenceProps, getFloatingProps, getItemProps } = useInteractions([click, role, listNavigation]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.


 const value = React.useMemo(
 () => ({
 value: {
 popoverCtx,
 elementId,
 getReferenceProps,
 getFloatingProps,
 getItemProps,
 activeIndex,
 elementsRef,
 },
 }),
 [popoverCtx, elementId, getReferenceProps, getFloatingProps, getItemProps, activeIndex],
 );

 return (
 <MenuStateCtx.Provider
Expand All@@ -50,8 +97,8 @@ type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: b

export const MenuTrigger = (props: MenuTriggerProps) => {
 const { children, ariaLabel } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { reference, toggle, isOpen } = popoverCtx;
 const { popoverCtx, elementId, getReferenceProps } = useMenuState();
 const { reference, isOpen } = popoverCtx;

 const normalizedAriaLabel = typeof ariaLabel === 'function' ? ariaLabel(isOpen) : ariaLabel;

Expand All@@ -64,86 +111,60 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
 elementDescriptor: children.props.elementDescriptor || descriptors.menuButton,
 elementId: children.props.elementId || descriptors.menuButton.setId(elementId),
 'aria-label': normalizedAriaLabel,
 'aria-expanded': isOpen,
 'aria-haspopup': 'menu',
 onClick: (e: React.MouseEvent) => {
 children.props?.onClick?.(e);
 toggle();
 },
 ...getReferenceProps({
 onClick: children.props?.onClick,
 }),
 });
};

const findMenuItem = (el: Element, siblingType: 'prev' | 'next', options?: { countSelf?: boolean }) => {
 let tagName = options?.countSelf ? el.tagName : '';
 let sibling: Element | null = el;
 while (sibling && tagName.toUpperCase() !== 'BUTTON') {
 sibling = sibling[siblingType === 'prev' ? 'previousElementSibling' : 'nextElementSibling'];
 tagName = sibling?.tagName ?? '';
 }
 return sibling;
};

type MenuListProps = PropsOfComponent<typeof Col> & {
 asPortal?: boolean;
};

export const MenuList = (props: MenuListProps) => {
 const { sx, asPortal, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getFloatingProps, elementsRef } = useMenuState();
 const { floating, styles, isOpen, context, nodeId } = popoverCtx;
 const containerRef = useRef<HTMLDivElement | null>(null);
 const mergedRef = useMergeRefs([containerRef, floating]);

 const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
 const current = containerRef.current;
 if (!current) {
 return;
 }

 if (current !== document.activeElement) {
 return;
 }

 if (e.key === 'ArrowDown') {
 e.preventDefault();
 return (findMenuItem(current.children[0], 'next', { countSelf: true }) as HTMLElement)?.focus();
 }
 };

 return (
 <Popover
 context={context}
 nodeId={nodeId}
 isOpen={isOpen}
 portal={asPortal}
 order={['content']}
 modal={false}
 >
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 role='menu'
 onKeyDown={onKeyDown}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...rest}
 />
 <FloatingList elementsRef={elementsRef}>
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...getFloatingProps()}
 {...rest}
 />
 </FloatingList>
 </Popover>
 );
};
Expand All@@ -155,43 +176,30 @@ type MenuItemProps = PropsOfComponent<typeof Button> & {

export const MenuItem = (props: MenuItemProps) => {
 const { sx, onClick, destructive, closeAfterClick = true, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getItemProps, activeIndex } = useMenuState();
 const { toggle } = popoverCtx;
 const buttonRef = useRef<HTMLButtonElement>(null);

 const onKeyDown = (e: React.KeyboardEvent<HTMLButtonElement>) => {
 const current = buttonRef.current;
 if (!current) {
 return;
 }

 const key = e.key;
 if (key !== 'ArrowUp' && key !== 'ArrowDown') {
 return;
 }

 e.preventDefault();
 const sibling = findMenuItem(current, key === 'ArrowUp' ? 'prev' : 'next');
 (sibling as HTMLElement)?.focus();
 };
 const item = useListItem();
 const isActive = item.index === activeIndex;

 return (
 <SimpleButton
 ref={buttonRef}
 ref={item.ref}
 elementDescriptor={descriptors.menuItem}
 elementId={descriptors.menuItem.setId(elementId)}
 hoverAsFocus
 variant='ghost'
 colorScheme={destructive ? 'danger' : 'neutral'}
 role='menuitem'
onKeyDown={onKeyDown}
tabIndex={isActive ? 0 : -1}
 focusRing={false}
 onClick={e => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 }}
 {...getItemProps({
 onClick: (e: React.MouseEvent<HTMLButtonElement>) => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 },
 })}
 sx={[
 theme => ({
 justifyContent: 'start',
Expand Down

10 changes: 10 additions & 0 deletions
packages/ui/src/elements/Popover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,13 @@ type PopoverProps = PropsWithChildren<{
 */
 outsideElementsInert?: boolean;
 order?: Array<'reference' | 'floating' | 'content'>;
 /**
 * Whether focus is trapped inside the floating element and outside elements
 * are marked `aria-hidden`. Dialogs should be `true`; menus / dropdowns should
 * be `false` so the trigger remains in the accessibility tree.
 * @default true
 */
 modal?: boolean;
 portal?: boolean;
 /**
 * The root element to render the portal into.
Expand All@@ -29,6 +36,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus,
 outsideElementsInert = false,
 order = ['reference', 'content'],
 modal = true,
 nodeId,
 isOpen,
 portal = true,
Expand All@@ -49,6 +57,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus={initialFocus}
 outsideElementsInert={outsideElementsInert}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand All@@ -65,6 +74,7 @@ export const Popover = (props: PopoverProps) => {
 context={context}
 initialFocus={initialFocus}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand Down

2 changes: 1 addition & 1 deletion
packages/ui/src/elements/ThreeDotsMenu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

 return (
 <Menu elementId={elementId}>
 <MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
 <MenuTrigger ariaLabel={(isOpen: boolean) => `${isOpen ? 'Close' : 'Open'} menu`}>
 <Button
 sx={t =>
 !isBordered
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
refactor(ui): Menu interaction and accessibility improvements by alexcarpenter · Pull Request #8333 · clerk/javascript · GitHub
Skip to content
refactor(ui): Menu interaction and accessibility improvements#8333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 5 commits into

from

Jun 18, 2026
 Merged


refactor(ui): Menu interaction and accessibility improvements
#8333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b7bbb60

refactor(ui): Menu interaction and accessibility improvements


alexcarpenter Apr 16, 2026
8fc7015

fix tests


alexcarpenter Apr 16, 2026
9fdec33

Create menu-keyboard-a11y.md


alexcarpenter Apr 16, 2026
b29716c

add disabled test case


alexcarpenter Apr 16, 2026
8d4b8cc

Merge branch 'main' into carp/menu-interaction-improvements


alexcarpenter Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/menu-keyboard-a11y.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Menu keyboard navigation and accessibility. Menus now support `Enter`/`Space` to open from the trigger, `ArrowDown`/`ArrowUp`/`Home`/`End` to move focus, `Escape` to close and return focus to the trigger, and skip disabled items during arrow-key navigation. Menus no longer mark the rest of the page as `aria-hidden` while open, so assistive technologies can still reach surrounding content.

23 changes: 22 additions & 1 deletion
packages/ui/src/components/UserProfile/__tests__/ConnectedAccountsSection.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,32 @@
import { CLERK_MODAL_STATE } from '@clerk/shared/internal/clerk-js/constants';
import type { ExternalAccountResource } from '@clerk/shared/types';
import { act, waitFor } from '@testing-library/react';
import type { ComponentType, PropsWithChildren } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render, screen } from '@/test/utils';

import { AppearanceProvider } from '../../../customizables';
import { ConnectedAccountsSection } from '../ConnectedAccountsSection';

// jsdom never fires CSS `animationend`/`transitionend` events, so
// `@formkit/auto-animate` (used by ProfileSection.ItemList) can never complete
// its exit animation and retains unmounted DOM nodes indefinitely. This
// prevents tests from deterministically asserting that a subtree was removed
// after a state change. Disabling animations via appearance options makes the
// Animated wrapper a no-op so React's unmount is reflected in the DOM
// synchronously. The real-browser animation path is covered by manual testing
// and by `Collapsible.test.tsx`.
const withAnimationsDisabled = (Wrapper: ComponentType<PropsWithChildren>) => {
 const WithAnimationsDisabled = ({ children }: PropsWithChildren) => (
 <Wrapper>
 <AppearanceProvider appearance={{ options: { animations: false } }}>{children}</AppearanceProvider>
 </Wrapper>
 );
 return WithAnimationsDisabled;
};

const { createFixtures } = bindCreateFixtures('UserProfile');

const withoutConnections = createFixtures.config(f => {
Expand DownExpand Up@@ -374,7 +393,9 @@ describe('ConnectedAccountsSection ', () => {
 describe('Handles opening/closing actions', () => {
 it('closes remove account form when connect account action is clicked', async () => {
 const { wrapper } = await createFixtures(withSomeConnections);
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, { wrapper });
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, {
 wrapper: withAnimationsDisabled(wrapper),
 });

 const item = getByText(/google/i);
 const menuButton = item.parentElement?.parentElement?.parentElement?.parentElement?.children?.[1];
Expand Down

190 changes: 99 additions & 91 deletions
packages/ui/src/elements/Menu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import {
 FloatingList,
 useClick,
 useInteractions,
 useListItem,
 useListNavigation,
 useMergeRefs,
 useRole,
} from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useRef } from 'react';

import { useMergeRefs } from '@floating-ui/react';

import type { Button } from '../customizables';
import { Col, descriptors, SimpleButton } from '../customizables';
import type { UsePopoverReturn } from '../hooks';
Expand All@@ -16,9 +23,16 @@ import { colors } from '../utils/colors';
import { withFloatingTree } from './contexts';
import { Popover } from './Popover';

type UseInteractionsReturn = ReturnType<typeof useInteractions>;

type MenuState = {
 popoverCtx: UsePopoverReturn;
 elementId?: MenuId;
 getReferenceProps: UseInteractionsReturn['getReferenceProps'];
 getFloatingProps: UseInteractionsReturn['getFloatingProps'];
 getItemProps: UseInteractionsReturn['getItemProps'];
 activeIndex: number | null;
 elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
};

export const [MenuStateCtx, useMenuState] = createContextAndHook<MenuState>('MenuState');
Expand All@@ -35,8 +49,41 @@ export const Menu = withFloatingTree((props: MenuProps) => {
 offset: 8,
 shoudFlip: true,
 });
 const { context, isOpen } = popoverCtx;

 const [activeIndex, setActiveIndex] = React.useState<number | null>(null);
 const elementsRef = useRef<Array<HTMLElement | null>>([]);

 const value = React.useMemo(() => ({ value: { popoverCtx, elementId } }), [{ ...popoverCtx }, elementId]);
 React.useEffect(() => {
 if (!isOpen) {
 setActiveIndex(null);
 }
 }, [isOpen]);

 const click = useClick(context);
 const role = useRole(context, { role: 'menu' });
 const listNavigation = useListNavigation(context, {
 listRef: elementsRef,
 activeIndex,
 onNavigate: setActiveIndex,
 loop: true,
 });
 const { getReferenceProps, getFloatingProps, getItemProps } = useInteractions([click, role, listNavigation]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.


 const value = React.useMemo(
 () => ({
 value: {
 popoverCtx,
 elementId,
 getReferenceProps,
 getFloatingProps,
 getItemProps,
 activeIndex,
 elementsRef,
 },
 }),
 [popoverCtx, elementId, getReferenceProps, getFloatingProps, getItemProps, activeIndex],
 );

 return (
 <MenuStateCtx.Provider
Expand All@@ -50,8 +97,8 @@ type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: b

export const MenuTrigger = (props: MenuTriggerProps) => {
 const { children, ariaLabel } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { reference, toggle, isOpen } = popoverCtx;
 const { popoverCtx, elementId, getReferenceProps } = useMenuState();
 const { reference, isOpen } = popoverCtx;

 const normalizedAriaLabel = typeof ariaLabel === 'function' ? ariaLabel(isOpen) : ariaLabel;

Expand All@@ -64,86 +111,60 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
 elementDescriptor: children.props.elementDescriptor || descriptors.menuButton,
 elementId: children.props.elementId || descriptors.menuButton.setId(elementId),
 'aria-label': normalizedAriaLabel,
 'aria-expanded': isOpen,
 'aria-haspopup': 'menu',
 onClick: (e: React.MouseEvent) => {
 children.props?.onClick?.(e);
 toggle();
 },
 ...getReferenceProps({
 onClick: children.props?.onClick,
 }),
 });
};

const findMenuItem = (el: Element, siblingType: 'prev' | 'next', options?: { countSelf?: boolean }) => {
 let tagName = options?.countSelf ? el.tagName : '';
 let sibling: Element | null = el;
 while (sibling && tagName.toUpperCase() !== 'BUTTON') {
 sibling = sibling[siblingType === 'prev' ? 'previousElementSibling' : 'nextElementSibling'];
 tagName = sibling?.tagName ?? '';
 }
 return sibling;
};

type MenuListProps = PropsOfComponent<typeof Col> & {
 asPortal?: boolean;
};

export const MenuList = (props: MenuListProps) => {
 const { sx, asPortal, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getFloatingProps, elementsRef } = useMenuState();
 const { floating, styles, isOpen, context, nodeId } = popoverCtx;
 const containerRef = useRef<HTMLDivElement | null>(null);
 const mergedRef = useMergeRefs([containerRef, floating]);

 const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
 const current = containerRef.current;
 if (!current) {
 return;
 }

 if (current !== document.activeElement) {
 return;
 }

 if (e.key === 'ArrowDown') {
 e.preventDefault();
 return (findMenuItem(current.children[0], 'next', { countSelf: true }) as HTMLElement)?.focus();
 }
 };

 return (
 <Popover
 context={context}
 nodeId={nodeId}
 isOpen={isOpen}
 portal={asPortal}
 order={['content']}
 modal={false}
 >
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 role='menu'
 onKeyDown={onKeyDown}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...rest}
 />
 <FloatingList elementsRef={elementsRef}>
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...getFloatingProps()}
 {...rest}
 />
 </FloatingList>
 </Popover>
 );
};
Expand All@@ -155,43 +176,30 @@ type MenuItemProps = PropsOfComponent<typeof Button> & {

export const MenuItem = (props: MenuItemProps) => {
 const { sx, onClick, destructive, closeAfterClick = true, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getItemProps, activeIndex } = useMenuState();
 const { toggle } = popoverCtx;
 const buttonRef = useRef<HTMLButtonElement>(null);

 const onKeyDown = (e: React.KeyboardEvent<HTMLButtonElement>) => {
 const current = buttonRef.current;
 if (!current) {
 return;
 }

 const key = e.key;
 if (key !== 'ArrowUp' && key !== 'ArrowDown') {
 return;
 }

 e.preventDefault();
 const sibling = findMenuItem(current, key === 'ArrowUp' ? 'prev' : 'next');
 (sibling as HTMLElement)?.focus();
 };
 const item = useListItem();
 const isActive = item.index === activeIndex;

 return (
 <SimpleButton
 ref={buttonRef}
 ref={item.ref}
 elementDescriptor={descriptors.menuItem}
 elementId={descriptors.menuItem.setId(elementId)}
 hoverAsFocus
 variant='ghost'
 colorScheme={destructive ? 'danger' : 'neutral'}
 role='menuitem'
onKeyDown={onKeyDown}
tabIndex={isActive ? 0 : -1}
 focusRing={false}
 onClick={e => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 }}
 {...getItemProps({
 onClick: (e: React.MouseEvent<HTMLButtonElement>) => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 },
 })}
 sx={[
 theme => ({
 justifyContent: 'start',
Expand Down

10 changes: 10 additions & 0 deletions
packages/ui/src/elements/Popover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,13 @@ type PopoverProps = PropsWithChildren<{
 */
 outsideElementsInert?: boolean;
 order?: Array<'reference' | 'floating' | 'content'>;
 /**
 * Whether focus is trapped inside the floating element and outside elements
 * are marked `aria-hidden`. Dialogs should be `true`; menus / dropdowns should
 * be `false` so the trigger remains in the accessibility tree.
 * @default true
 */
 modal?: boolean;
 portal?: boolean;
 /**
 * The root element to render the portal into.
Expand All@@ -29,6 +36,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus,
 outsideElementsInert = false,
 order = ['reference', 'content'],
 modal = true,
 nodeId,
 isOpen,
 portal = true,
Expand All@@ -49,6 +57,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus={initialFocus}
 outsideElementsInert={outsideElementsInert}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand All@@ -65,6 +74,7 @@ export const Popover = (props: PopoverProps) => {
 context={context}
 initialFocus={initialFocus}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand Down

2 changes: 1 addition & 1 deletion
packages/ui/src/elements/ThreeDotsMenu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

 return (
 <Menu elementId={elementId}>
 <MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
 <MenuTrigger ariaLabel={(isOpen: boolean) => `${isOpen ? 'Close' : 'Open'} menu`}>
 <Button
 sx={t =>
 !isBordered
Expand Down
Loading
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
refactor(ui): Menu interaction and accessibility improvements by alexcarpenter · Pull Request #8333 · clerk/javascript · GitHub
Skip to content
refactor(ui): Menu interaction and accessibility improvements#8333

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

alexcarpenter
merged 5 commits into

from

Jun 18, 2026
 Merged


refactor(ui): Menu interaction and accessibility improvements
#8333
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
b7bbb60

refactor(ui): Menu interaction and accessibility improvements


alexcarpenter Apr 16, 2026
8fc7015

fix tests


alexcarpenter Apr 16, 2026
9fdec33

Create menu-keyboard-a11y.md


alexcarpenter Apr 16, 2026
b29716c

add disabled test case


alexcarpenter Apr 16, 2026
8d4b8cc

Merge branch 'main' into carp/menu-interaction-improvements


alexcarpenter Jun 18, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


5 changes: 5 additions & 0 deletions
.changeset/menu-keyboard-a11y.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Menu keyboard navigation and accessibility. Menus now support `Enter`/`Space` to open from the trigger, `ArrowDown`/`ArrowUp`/`Home`/`End` to move focus, `Escape` to close and return focus to the trigger, and skip disabled items during arrow-key navigation. Menus no longer mark the rest of the page as `aria-hidden` while open, so assistive technologies can still reach surrounding content.

23 changes: 22 additions & 1 deletion
packages/ui/src/components/UserProfile/__tests__/ConnectedAccountsSection.test.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,13 +1,32 @@
import { CLERK_MODAL_STATE } from '@clerk/shared/internal/clerk-js/constants';
import type { ExternalAccountResource } from '@clerk/shared/types';
import { act, waitFor } from '@testing-library/react';
import type { ComponentType, PropsWithChildren } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { bindCreateFixtures } from '@/test/create-fixtures';
import { render, screen } from '@/test/utils';

import { AppearanceProvider } from '../../../customizables';
import { ConnectedAccountsSection } from '../ConnectedAccountsSection';

// jsdom never fires CSS `animationend`/`transitionend` events, so
// `@formkit/auto-animate` (used by ProfileSection.ItemList) can never complete
// its exit animation and retains unmounted DOM nodes indefinitely. This
// prevents tests from deterministically asserting that a subtree was removed
// after a state change. Disabling animations via appearance options makes the
// Animated wrapper a no-op so React's unmount is reflected in the DOM
// synchronously. The real-browser animation path is covered by manual testing
// and by `Collapsible.test.tsx`.
const withAnimationsDisabled = (Wrapper: ComponentType<PropsWithChildren>) => {
 const WithAnimationsDisabled = ({ children }: PropsWithChildren) => (
 <Wrapper>
 <AppearanceProvider appearance={{ options: { animations: false } }}>{children}</AppearanceProvider>
 </Wrapper>
 );
 return WithAnimationsDisabled;
};

const { createFixtures } = bindCreateFixtures('UserProfile');

const withoutConnections = createFixtures.config(f => {
Expand DownExpand Up@@ -374,7 +393,9 @@ describe('ConnectedAccountsSection ', () => {
 describe('Handles opening/closing actions', () => {
 it('closes remove account form when connect account action is clicked', async () => {
 const { wrapper } = await createFixtures(withSomeConnections);
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, { wrapper });
 const { userEvent, getByText, getByRole, queryByRole } = render(<ConnectedAccountsSection />, {
 wrapper: withAnimationsDisabled(wrapper),
 });

 const item = getByText(/google/i);
 const menuButton = item.parentElement?.parentElement?.parentElement?.parentElement?.children?.[1];
Expand Down

190 changes: 99 additions & 91 deletions
packages/ui/src/elements/Menu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,11 +1,18 @@
import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import {
 FloatingList,
 useClick,
 useInteractions,
 useListItem,
 useListNavigation,
 useMergeRefs,
 useRole,
} from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useRef } from 'react';

import { useMergeRefs } from '@floating-ui/react';

import type { Button } from '../customizables';
import { Col, descriptors, SimpleButton } from '../customizables';
import type { UsePopoverReturn } from '../hooks';
Expand All@@ -16,9 +23,16 @@ import { colors } from '../utils/colors';
import { withFloatingTree } from './contexts';
import { Popover } from './Popover';

type UseInteractionsReturn = ReturnType<typeof useInteractions>;

type MenuState = {
 popoverCtx: UsePopoverReturn;
 elementId?: MenuId;
 getReferenceProps: UseInteractionsReturn['getReferenceProps'];
 getFloatingProps: UseInteractionsReturn['getFloatingProps'];
 getItemProps: UseInteractionsReturn['getItemProps'];
 activeIndex: number | null;
 elementsRef: React.MutableRefObject<Array<HTMLElement | null>>;
};

export const [MenuStateCtx, useMenuState] = createContextAndHook<MenuState>('MenuState');
Expand All@@ -35,8 +49,41 @@ export const Menu = withFloatingTree((props: MenuProps) => {
 offset: 8,
 shoudFlip: true,
 });
 const { context, isOpen } = popoverCtx;

 const [activeIndex, setActiveIndex] = React.useState<number | null>(null);
 const elementsRef = useRef<Array<HTMLElement | null>>([]);

 const value = React.useMemo(() => ({ value: { popoverCtx, elementId } }), [{ ...popoverCtx }, elementId]);
 React.useEffect(() => {
 if (!isOpen) {
 setActiveIndex(null);
 }
 }, [isOpen]);

 const click = useClick(context);
 const role = useRole(context, { role: 'menu' });
 const listNavigation = useListNavigation(context, {
 listRef: elementsRef,
 activeIndex,
 onNavigate: setActiveIndex,
 loop: true,
 });
 const { getReferenceProps, getFloatingProps, getItemProps } = useInteractions([click, role, listNavigation]);
Comment thread
coderabbitai[bot] marked this conversation as resolved.


 const value = React.useMemo(
 () => ({
 value: {
 popoverCtx,
 elementId,
 getReferenceProps,
 getFloatingProps,
 getItemProps,
 activeIndex,
 elementsRef,
 },
 }),
 [popoverCtx, elementId, getReferenceProps, getFloatingProps, getItemProps, activeIndex],
 );

 return (
 <MenuStateCtx.Provider
Expand All@@ -50,8 +97,8 @@ type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: b

export const MenuTrigger = (props: MenuTriggerProps) => {
 const { children, ariaLabel } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { reference, toggle, isOpen } = popoverCtx;
 const { popoverCtx, elementId, getReferenceProps } = useMenuState();
 const { reference, isOpen } = popoverCtx;

 const normalizedAriaLabel = typeof ariaLabel === 'function' ? ariaLabel(isOpen) : ariaLabel;

Expand All@@ -64,86 +111,60 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
 elementDescriptor: children.props.elementDescriptor || descriptors.menuButton,
 elementId: children.props.elementId || descriptors.menuButton.setId(elementId),
 'aria-label': normalizedAriaLabel,
 'aria-expanded': isOpen,
 'aria-haspopup': 'menu',
 onClick: (e: React.MouseEvent) => {
 children.props?.onClick?.(e);
 toggle();
 },
 ...getReferenceProps({
 onClick: children.props?.onClick,
 }),
 });
};

const findMenuItem = (el: Element, siblingType: 'prev' | 'next', options?: { countSelf?: boolean }) => {
 let tagName = options?.countSelf ? el.tagName : '';
 let sibling: Element | null = el;
 while (sibling && tagName.toUpperCase() !== 'BUTTON') {
 sibling = sibling[siblingType === 'prev' ? 'previousElementSibling' : 'nextElementSibling'];
 tagName = sibling?.tagName ?? '';
 }
 return sibling;
};

type MenuListProps = PropsOfComponent<typeof Col> & {
 asPortal?: boolean;
};

export const MenuList = (props: MenuListProps) => {
 const { sx, asPortal, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getFloatingProps, elementsRef } = useMenuState();
 const { floating, styles, isOpen, context, nodeId } = popoverCtx;
 const containerRef = useRef<HTMLDivElement | null>(null);
 const mergedRef = useMergeRefs([containerRef, floating]);

 const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
 const current = containerRef.current;
 if (!current) {
 return;
 }

 if (current !== document.activeElement) {
 return;
 }

 if (e.key === 'ArrowDown') {
 e.preventDefault();
 return (findMenuItem(current.children[0], 'next', { countSelf: true }) as HTMLElement)?.focus();
 }
 };

 return (
 <Popover
 context={context}
 nodeId={nodeId}
 isOpen={isOpen}
 portal={asPortal}
 order={['content']}
 modal={false}
 >
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 role='menu'
 onKeyDown={onKeyDown}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...rest}
 />
 <FloatingList elementsRef={elementsRef}>
 <Col
 elementDescriptor={descriptors.menuList}
 elementId={descriptors.menuList.setId(elementId)}
 ref={mergedRef}
 sx={[
 t => ({
 backgroundColor: colors.makeSolid(t.colors.$colorBackground),
 borderWidth: t.borderWidths.$normal,
 borderStyle: t.borderStyles.$solid,
 borderColor: t.colors.$borderAlpha150,
 outline: 'none',
 borderRadius: t.radii.$md,
 padding: t.space.$0x5,
 overflow: 'hidden',
 top: `calc(100% + ${t.space.$2})`,
 animation: `${animations.dropdownSlideInScaleAndFade} ${t.transitionDuration.$slower} ${t.transitionTiming.$slowBezier}`,
 transformOrigin: 'top center',
 zIndex: t.zIndices.$dropdown,
 gap: t.space.$0x5,
 }),
 sx,
 ]}
 style={styles}
 {...getFloatingProps()}
 {...rest}
 />
 </FloatingList>
 </Popover>
 );
};
Expand All@@ -155,43 +176,30 @@ type MenuItemProps = PropsOfComponent<typeof Button> & {

export const MenuItem = (props: MenuItemProps) => {
 const { sx, onClick, destructive, closeAfterClick = true, ...rest } = props;
 const { popoverCtx, elementId } = useMenuState();
 const { popoverCtx, elementId, getItemProps, activeIndex } = useMenuState();
 const { toggle } = popoverCtx;
 const buttonRef = useRef<HTMLButtonElement>(null);

 const onKeyDown = (e: React.KeyboardEvent<HTMLButtonElement>) => {
 const current = buttonRef.current;
 if (!current) {
 return;
 }

 const key = e.key;
 if (key !== 'ArrowUp' && key !== 'ArrowDown') {
 return;
 }

 e.preventDefault();
 const sibling = findMenuItem(current, key === 'ArrowUp' ? 'prev' : 'next');
 (sibling as HTMLElement)?.focus();
 };
 const item = useListItem();
 const isActive = item.index === activeIndex;

 return (
 <SimpleButton
 ref={buttonRef}
 ref={item.ref}
 elementDescriptor={descriptors.menuItem}
 elementId={descriptors.menuItem.setId(elementId)}
 hoverAsFocus
 variant='ghost'
 colorScheme={destructive ? 'danger' : 'neutral'}
 role='menuitem'
onKeyDown={onKeyDown}
tabIndex={isActive ? 0 : -1}
 focusRing={false}
 onClick={e => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 }}
 {...getItemProps({
 onClick: (e: React.MouseEvent<HTMLButtonElement>) => {
 onClick?.(e);
 if (closeAfterClick) {
 toggle();
 }
 },
 })}
 sx={[
 theme => ({
 justifyContent: 'start',
Expand Down

10 changes: 10 additions & 0 deletions
packages/ui/src/elements/Popover.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -15,6 +15,13 @@ type PopoverProps = PropsWithChildren<{
 */
 outsideElementsInert?: boolean;
 order?: Array<'reference' | 'floating' | 'content'>;
 /**
 * Whether focus is trapped inside the floating element and outside elements
 * are marked `aria-hidden`. Dialogs should be `true`; menus / dropdowns should
 * be `false` so the trigger remains in the accessibility tree.
 * @default true
 */
 modal?: boolean;
 portal?: boolean;
 /**
 * The root element to render the portal into.
Expand All@@ -29,6 +36,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus,
 outsideElementsInert = false,
 order = ['reference', 'content'],
 modal = true,
 nodeId,
 isOpen,
 portal = true,
Expand All@@ -49,6 +57,7 @@ export const Popover = (props: PopoverProps) => {
 initialFocus={initialFocus}
 outsideElementsInert={outsideElementsInert}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand All@@ -65,6 +74,7 @@ export const Popover = (props: PopoverProps) => {
 context={context}
 initialFocus={initialFocus}
 order={order}
 modal={modal}
 >
 <>{children}</>
 </FloatingFocusManager>
Expand Down

2 changes: 1 addition & 1 deletion
packages/ui/src/elements/ThreeDotsMenu.tsx

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

 return (
 <Menu elementId={elementId}>
 <MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
 <MenuTrigger ariaLabel={(isOpen: boolean) => `${isOpen ? 'Close' : 'Open'} menu`}>
 <Button
 sx={t =>
 !isBordered
Expand Down
Loading
Loading