Skip to content
Merged
5 changes: 5 additions & 0 deletions .changeset/floating-ui-aria-fixes.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Floating UI usage: fix `arialLabel` typo in `MenuTrigger`, replace imperative floating ref in `MenuList` with `useMergeRefs`, remove manual position offset in `SelectOptionList`, add `aria-haspopup` to `MenuTrigger`, and add missing ARIA attributes (`aria-expanded`, `aria-haspopup`, `role`, `aria-selected`) to `Select` components.
19 changes: 9 additions & 10 deletions packages/ui/src/elements/Menu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@ import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useLayoutEffect, useRef } 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';
Expand DownExpand Up@@ -44,14 +46,14 @@ export const Menu = withFloatingTree((props: MenuProps) => {
);
});

type MenuTriggerProps = React.PropsWithChildren<{ arialLabel?: string | ((open: boolean) => string) }>;
type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: boolean) => string) }>;

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

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

if (!isValidElement(children)) {
return null;
Expand All@@ -64,6 +66,7 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
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();
Expand All@@ -90,11 +93,7 @@ export const MenuList = (props: MenuListProps) => {
const { popoverCtx, elementId } = useMenuState();
const { floating, styles, isOpen, context, nodeId } = popoverCtx;
const containerRef = useRef<HTMLDivElement | null>(null);

useLayoutEffect(() => {
const current = containerRef.current;
floating(current);
}, [isOpen]);
const mergedRef = useMergeRefs([containerRef, floating]);

const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
const current = containerRef.current;
Expand DownExpand Up@@ -122,7 +121,7 @@ export const MenuList = (props: MenuListProps) => {
<Col
elementDescriptor={descriptors.menuList}
elementId={descriptors.menuList.setId(elementId)}
ref={containerRef}
ref={mergedRef}
role='menu'
onKeyDown={onKeyDown}
sx={[
Expand Down
74 changes: 67 additions & 7 deletions packages/ui/src/elements/Select.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ type SelectState<O extends Option> = Pick<
select: (option: O) => void;
focusedItemRef: React.RefObject<HTMLDivElement>;
onTriggerClick: () => void;
generatedTriggerId: string;
triggerId: string;
setTriggerId: React.Dispatch<React.SetStateAction<string>>;
generatedListboxId: string;
listboxId: string;
setListboxId: React.Dispatch<React.SetStateAction<string>>;
portal?: boolean;
};

Expand DownExpand Up@@ -97,11 +103,17 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
} = props;
const popoverCtx = usePopover({
autoUpdate: true,
adjustToReferenceWidth: !!referenceElement,
// +2px compensates for the 1px border on each side of the trigger
adjustToReferenceWidth: 2,
referenceElement: referenceElement,
offset: { mainAxis: 6, crossAxis: -1 },
});
const togglePopover = popoverCtx.toggle;
const focusedItemRef = React.useRef<HTMLDivElement>(null);
const generatedTriggerId = React.useId();
const generatedListboxId = React.useId();
const [triggerId, setTriggerId] = React.useState(generatedTriggerId);
const [listboxId, setListboxId] = React.useState(generatedListboxId);
const searchInputCtx = useSearchInput({
items: options,
comparator: comparator || (() => true),
Expand DownExpand Up@@ -139,6 +151,12 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
comparator,
select,
onTriggerClick: togglePopover,
generatedTriggerId,
triggerId,
setTriggerId,
generatedListboxId,
listboxId,
setListboxId,
elementId,
portal,
},
Expand DownExpand Up@@ -167,6 +185,8 @@ const SelectRenderOption = React.memo(
return (
<Flex
ref={ref}
role='option'
aria-selected={isSelected}
sx={{
userSelect: 'none',
cursor: 'pointer',
Expand DownExpand Up@@ -240,7 +260,16 @@ type SelectOptionListProps = PropsOfComponent<typeof Flex> & {
};

export const SelectOptionList = (props: SelectOptionListProps) => {
const { containerSx, sx, footer, onReachEnd, ...rest } = props;
const {
containerSx,
sx,
footer,
onReachEnd,
id,
'aria-label': ariaLabel,
'aria-labelledby': ariaLabelledBy,
...rest
} = props;
const {
popoverCtx,
searchInputCtx,
Expand All@@ -253,12 +282,21 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
select,
onTriggerClick,
elementId,
triggerId,
generatedListboxId,
setListboxId,
portal,
} = useSelectState();
const { filteredItems: options, searchInputProps } = searchInputCtx;
const [focusedIndex, setFocusedIndex] = useState(0);
const { isOpen, floating, styles, nodeId, context } = popoverCtx;
const containerRef = React.useRef<HTMLDivElement>(null);
const effectiveListboxId = id ?? generatedListboxId;
const effectiveAriaLabelledBy = ariaLabelledBy ?? (ariaLabel ? undefined : triggerId);

React.useEffect(() => {
setListboxId(effectiveListboxId);
}, [effectiveListboxId, setListboxId]);

const scrollToItemOnSelectedIndexChange = () => {
if (!isOpen) {
Expand DownExpand Up@@ -338,8 +376,7 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
}),
sx,
]}
// eslint-disable-next-line custom-rules/no-physical-css-properties -- Floating UI library positioning
style={{ ...styles, left: styles.left - 1 }}
style={styles}
>
{comparator && (
<SelectSearchbar
Expand All@@ -349,7 +386,11 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
)}
<Flex
ref={containerRef}
id={effectiveListboxId}
direction='col'
role='listbox'
aria-label={ariaLabel}
aria-labelledby={effectiveAriaLabelledBy}
tabIndex={comparator ? undefined : 0}
sx={[
theme => ({
Expand DownExpand Up@@ -395,9 +436,24 @@ export const SelectButton = (
iconSx?: ThemableCssProp;
},
) => {
const { sx, children, icon, iconSx, ...rest } = props;
const { popoverCtx, onTriggerClick, buttonRenderOption, selectedOption, placeholder, elementId } = useSelectState();
const { reference } = popoverCtx;
const { sx, children, icon, iconSx, id, 'aria-controls': ariaControls, ...rest } = props;
const {
popoverCtx,
onTriggerClick,
buttonRenderOption,
selectedOption,
placeholder,
elementId,
generatedTriggerId,
listboxId,
setTriggerId,
} = useSelectState();
const { reference, isOpen } = popoverCtx;
const effectiveTriggerId = id ?? generatedTriggerId;

React.useEffect(() => {
setTriggerId(effectiveTriggerId);
}, [effectiveTriggerId, setTriggerId]);

let show: React.ReactNode = children;
if (!children) {
Expand All@@ -409,9 +465,13 @@ export const SelectButton = (
elementDescriptor={descriptors.selectButton}
elementId={descriptors.selectButton.setId(elementId)}
ref={reference}
id={effectiveTriggerId}
variant='outline'
textVariant='buttonLarge'
onClick={onTriggerClick}
aria-expanded={isOpen}
aria-haspopup='listbox'
aria-controls={ariaControls ?? (isOpen ? listboxId : undefined)}
sx={[
theme => ({
gap: theme.space.$2,
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/elements/ThreeDotsMenu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

return (
<Menu elementId={elementId}>
<MenuTrigger arialLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<Button
sx={t =>
!isBordered
Expand Down
121 changes: 121 additions & 0 deletions packages/ui/src/elements/__tests__/Select.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { ClerkInstanceContext } from '@clerk/shared/react';
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import type { PropsWithChildren, ReactElement } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { EnvironmentProvider } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { InternalThemeProvider } from '../../styledSystem';
import { Select, SelectButton, SelectOptionList } from '../Select';

const options = [
{ value: 'one', label: 'One' },
{ value: 'two', label: 'Two' },
];

const TestProviders = ({ children }: PropsWithChildren) => (
<ClerkInstanceContext.Provider value={{ value: { client: {}, user: {} } as any }}>
<EnvironmentProvider value={{ displayConfig: { applicationName: 'TestApp' } } as any}>
<AppearanceProvider>
<InternalThemeProvider>{children}</InternalThemeProvider>
</AppearanceProvider>
</EnvironmentProvider>
</ClerkInstanceContext.Provider>
);

const renderSelect = (ui: ReactElement) => {
return render(ui, { wrapper: TestProviders });
};

describe('Select', () => {
it('labels the listbox with the generated trigger id by default', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
/>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(button).toHaveAttribute('id');
expect(listbox).toHaveAttribute('id');
expect(listbox).toHaveAttribute('aria-labelledby', button.id);
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('labels the listbox with an explicit trigger id', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton id='expiration-field' />
<SelectOptionList />
</Select>,
);

const button = document.getElementById('expiration-field') as HTMLButtonElement;

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(listbox).toHaveAttribute('aria-labelledby', 'expiration-field');
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('preserves an explicit listbox aria-label', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton />
<SelectOptionList aria-label='Expiration options' />
</Select>,
);

await user.click(screen.getByRole('button', { name: 'Select an option' }));

const listbox = await screen.findByRole('listbox', { name: 'Expiration options' });

expect(listbox).toHaveAttribute('aria-label', 'Expiration options');
expect(listbox).not.toHaveAttribute('aria-labelledby');
});

it('preserves an explicit listbox aria-labelledby', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<span id='external-label'>External options</span>
<SelectButton />
<SelectOptionList aria-labelledby='external-label' />
</Select>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox', { name: 'External options' });

expect(listbox).toHaveAttribute('aria-labelledby', 'external-label');
expect(listbox).not.toHaveAttribute('aria-labelledby', button.id);
});
});
7 changes: 4 additions & 3 deletions packages/ui/src/hooks/usePopover.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ type UsePopoverProps = {
shoudFlip?: boolean;
autoUpdate?: boolean;
outsidePress?: boolean | ((event: MouseEvent) => boolean);
adjustToReferenceWidth?: boolean;
adjustToReferenceWidth?: boolean | number;
referenceElement?: React.RefObject<HTMLElement> | null;
canCloseModal?: boolean;
bubbles?:
Expand DownExpand Up@@ -60,9 +60,10 @@ export const usePopover = (props: UsePopoverProps = {}): UsePopoverReturn => {
shift(),
size({
apply({ elements }) {
if (adjustToReferenceWidth) {
if (typeof adjustToReferenceWidth === 'number' || adjustToReferenceWidth === true) {
const reference = elements.reference as any as HTMLElement;
elements.floating.style.width = reference ? `${reference?.offsetWidth}px` : '';
const extra = typeof adjustToReferenceWidth === 'number' ? adjustToReferenceWidth : 0;
elements.floating.style.width = reference ? `${reference.offsetWidth + extra}px` : '';
}
},
}),
Expand Down
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" + '
fix(ui): Improve Floating UI usage by alexcarpenter · Pull Request #8328 · clerk/javascript · GitHub
Skip to content
Merged
5 changes: 5 additions & 0 deletions .changeset/floating-ui-aria-fixes.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Floating UI usage: fix `arialLabel` typo in `MenuTrigger`, replace imperative floating ref in `MenuList` with `useMergeRefs`, remove manual position offset in `SelectOptionList`, add `aria-haspopup` to `MenuTrigger`, and add missing ARIA attributes (`aria-expanded`, `aria-haspopup`, `role`, `aria-selected`) to `Select` components.
19 changes: 9 additions & 10 deletions packages/ui/src/elements/Menu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@ import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useLayoutEffect, useRef } 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';
Expand DownExpand Up@@ -44,14 +46,14 @@ export const Menu = withFloatingTree((props: MenuProps) => {
);
});

type MenuTriggerProps = React.PropsWithChildren<{ arialLabel?: string | ((open: boolean) => string) }>;
type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: boolean) => string) }>;

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

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

if (!isValidElement(children)) {
return null;
Expand All@@ -64,6 +66,7 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
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();
Expand All@@ -90,11 +93,7 @@ export const MenuList = (props: MenuListProps) => {
const { popoverCtx, elementId } = useMenuState();
const { floating, styles, isOpen, context, nodeId } = popoverCtx;
const containerRef = useRef<HTMLDivElement | null>(null);

useLayoutEffect(() => {
const current = containerRef.current;
floating(current);
}, [isOpen]);
const mergedRef = useMergeRefs([containerRef, floating]);

const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
const current = containerRef.current;
Expand DownExpand Up@@ -122,7 +121,7 @@ export const MenuList = (props: MenuListProps) => {
<Col
elementDescriptor={descriptors.menuList}
elementId={descriptors.menuList.setId(elementId)}
ref={containerRef}
ref={mergedRef}
role='menu'
onKeyDown={onKeyDown}
sx={[
Expand Down
74 changes: 67 additions & 7 deletions packages/ui/src/elements/Select.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ type SelectState<O extends Option> = Pick<
select: (option: O) => void;
focusedItemRef: React.RefObject<HTMLDivElement>;
onTriggerClick: () => void;
generatedTriggerId: string;
triggerId: string;
setTriggerId: React.Dispatch<React.SetStateAction<string>>;
generatedListboxId: string;
listboxId: string;
setListboxId: React.Dispatch<React.SetStateAction<string>>;
portal?: boolean;
};

Expand DownExpand Up@@ -97,11 +103,17 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
} = props;
const popoverCtx = usePopover({
autoUpdate: true,
adjustToReferenceWidth: !!referenceElement,
// +2px compensates for the 1px border on each side of the trigger
adjustToReferenceWidth: 2,
referenceElement: referenceElement,
offset: { mainAxis: 6, crossAxis: -1 },
});
const togglePopover = popoverCtx.toggle;
const focusedItemRef = React.useRef<HTMLDivElement>(null);
const generatedTriggerId = React.useId();
const generatedListboxId = React.useId();
const [triggerId, setTriggerId] = React.useState(generatedTriggerId);
const [listboxId, setListboxId] = React.useState(generatedListboxId);
const searchInputCtx = useSearchInput({
items: options,
comparator: comparator || (() => true),
Expand DownExpand Up@@ -139,6 +151,12 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
comparator,
select,
onTriggerClick: togglePopover,
generatedTriggerId,
triggerId,
setTriggerId,
generatedListboxId,
listboxId,
setListboxId,
elementId,
portal,
},
Expand DownExpand Up@@ -167,6 +185,8 @@ const SelectRenderOption = React.memo(
return (
<Flex
ref={ref}
role='option'
aria-selected={isSelected}
sx={{
userSelect: 'none',
cursor: 'pointer',
Expand DownExpand Up@@ -240,7 +260,16 @@ type SelectOptionListProps = PropsOfComponent<typeof Flex> & {
};

export const SelectOptionList = (props: SelectOptionListProps) => {
const { containerSx, sx, footer, onReachEnd, ...rest } = props;
const {
containerSx,
sx,
footer,
onReachEnd,
id,
'aria-label': ariaLabel,
'aria-labelledby': ariaLabelledBy,
...rest
} = props;
const {
popoverCtx,
searchInputCtx,
Expand All@@ -253,12 +282,21 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
select,
onTriggerClick,
elementId,
triggerId,
generatedListboxId,
setListboxId,
portal,
} = useSelectState();
const { filteredItems: options, searchInputProps } = searchInputCtx;
const [focusedIndex, setFocusedIndex] = useState(0);
const { isOpen, floating, styles, nodeId, context } = popoverCtx;
const containerRef = React.useRef<HTMLDivElement>(null);
const effectiveListboxId = id ?? generatedListboxId;
const effectiveAriaLabelledBy = ariaLabelledBy ?? (ariaLabel ? undefined : triggerId);

React.useEffect(() => {
setListboxId(effectiveListboxId);
}, [effectiveListboxId, setListboxId]);

const scrollToItemOnSelectedIndexChange = () => {
if (!isOpen) {
Expand DownExpand Up@@ -338,8 +376,7 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
}),
sx,
]}
// eslint-disable-next-line custom-rules/no-physical-css-properties -- Floating UI library positioning
style={{ ...styles, left: styles.left - 1 }}
style={styles}
>
{comparator && (
<SelectSearchbar
Expand All@@ -349,7 +386,11 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
)}
<Flex
ref={containerRef}
id={effectiveListboxId}
direction='col'
role='listbox'
aria-label={ariaLabel}
aria-labelledby={effectiveAriaLabelledBy}
tabIndex={comparator ? undefined : 0}
sx={[
theme => ({
Expand DownExpand Up@@ -395,9 +436,24 @@ export const SelectButton = (
iconSx?: ThemableCssProp;
},
) => {
const { sx, children, icon, iconSx, ...rest } = props;
const { popoverCtx, onTriggerClick, buttonRenderOption, selectedOption, placeholder, elementId } = useSelectState();
const { reference } = popoverCtx;
const { sx, children, icon, iconSx, id, 'aria-controls': ariaControls, ...rest } = props;
const {
popoverCtx,
onTriggerClick,
buttonRenderOption,
selectedOption,
placeholder,
elementId,
generatedTriggerId,
listboxId,
setTriggerId,
} = useSelectState();
const { reference, isOpen } = popoverCtx;
const effectiveTriggerId = id ?? generatedTriggerId;

React.useEffect(() => {
setTriggerId(effectiveTriggerId);
}, [effectiveTriggerId, setTriggerId]);

let show: React.ReactNode = children;
if (!children) {
Expand All@@ -409,9 +465,13 @@ export const SelectButton = (
elementDescriptor={descriptors.selectButton}
elementId={descriptors.selectButton.setId(elementId)}
ref={reference}
id={effectiveTriggerId}
variant='outline'
textVariant='buttonLarge'
onClick={onTriggerClick}
aria-expanded={isOpen}
aria-haspopup='listbox'
aria-controls={ariaControls ?? (isOpen ? listboxId : undefined)}
sx={[
theme => ({
gap: theme.space.$2,
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/elements/ThreeDotsMenu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

return (
<Menu elementId={elementId}>
<MenuTrigger arialLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<Button
sx={t =>
!isBordered
Expand Down
121 changes: 121 additions & 0 deletions packages/ui/src/elements/__tests__/Select.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { ClerkInstanceContext } from '@clerk/shared/react';
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import type { PropsWithChildren, ReactElement } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { EnvironmentProvider } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { InternalThemeProvider } from '../../styledSystem';
import { Select, SelectButton, SelectOptionList } from '../Select';

const options = [
{ value: 'one', label: 'One' },
{ value: 'two', label: 'Two' },
];

const TestProviders = ({ children }: PropsWithChildren) => (
<ClerkInstanceContext.Provider value={{ value: { client: {}, user: {} } as any }}>
<EnvironmentProvider value={{ displayConfig: { applicationName: 'TestApp' } } as any}>
<AppearanceProvider>
<InternalThemeProvider>{children}</InternalThemeProvider>
</AppearanceProvider>
</EnvironmentProvider>
</ClerkInstanceContext.Provider>
);

const renderSelect = (ui: ReactElement) => {
return render(ui, { wrapper: TestProviders });
};

describe('Select', () => {
it('labels the listbox with the generated trigger id by default', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
/>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(button).toHaveAttribute('id');
expect(listbox).toHaveAttribute('id');
expect(listbox).toHaveAttribute('aria-labelledby', button.id);
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('labels the listbox with an explicit trigger id', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton id='expiration-field' />
<SelectOptionList />
</Select>,
);

const button = document.getElementById('expiration-field') as HTMLButtonElement;

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(listbox).toHaveAttribute('aria-labelledby', 'expiration-field');
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('preserves an explicit listbox aria-label', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton />
<SelectOptionList aria-label='Expiration options' />
</Select>,
);

await user.click(screen.getByRole('button', { name: 'Select an option' }));

const listbox = await screen.findByRole('listbox', { name: 'Expiration options' });

expect(listbox).toHaveAttribute('aria-label', 'Expiration options');
expect(listbox).not.toHaveAttribute('aria-labelledby');
});

it('preserves an explicit listbox aria-labelledby', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<span id='external-label'>External options</span>
<SelectButton />
<SelectOptionList aria-labelledby='external-label' />
</Select>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox', { name: 'External options' });

expect(listbox).toHaveAttribute('aria-labelledby', 'external-label');
expect(listbox).not.toHaveAttribute('aria-labelledby', button.id);
});
});
7 changes: 4 additions & 3 deletions packages/ui/src/hooks/usePopover.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ type UsePopoverProps = {
shoudFlip?: boolean;
autoUpdate?: boolean;
outsidePress?: boolean | ((event: MouseEvent) => boolean);
adjustToReferenceWidth?: boolean;
adjustToReferenceWidth?: boolean | number;
referenceElement?: React.RefObject<HTMLElement> | null;
canCloseModal?: boolean;
bubbles?:
Expand DownExpand Up@@ -60,9 +60,10 @@ export const usePopover = (props: UsePopoverProps = {}): UsePopoverReturn => {
shift(),
size({
apply({ elements }) {
if (adjustToReferenceWidth) {
if (typeof adjustToReferenceWidth === 'number' || adjustToReferenceWidth === true) {
const reference = elements.reference as any as HTMLElement;
elements.floating.style.width = reference ? `${reference?.offsetWidth}px` : '';
const extra = typeof adjustToReferenceWidth === 'number' ? adjustToReferenceWidth : 0;
elements.floating.style.width = reference ? `${reference.offsetWidth + extra}px` : '';
}
},
}),
Expand Down
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('^' + ".*" + ' fix(ui): Improve Floating UI usage by alexcarpenter · Pull Request #8328 · clerk/javascript · GitHub
Skip to content
Merged
5 changes: 5 additions & 0 deletions .changeset/floating-ui-aria-fixes.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Floating UI usage: fix `arialLabel` typo in `MenuTrigger`, replace imperative floating ref in `MenuList` with `useMergeRefs`, remove manual position offset in `SelectOptionList`, add `aria-haspopup` to `MenuTrigger`, and add missing ARIA attributes (`aria-expanded`, `aria-haspopup`, `role`, `aria-selected`) to `Select` components.
19 changes: 9 additions & 10 deletions packages/ui/src/elements/Menu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@ import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useLayoutEffect, useRef } 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';
Expand DownExpand Up@@ -44,14 +46,14 @@ export const Menu = withFloatingTree((props: MenuProps) => {
);
});

type MenuTriggerProps = React.PropsWithChildren<{ arialLabel?: string | ((open: boolean) => string) }>;
type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: boolean) => string) }>;

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

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

if (!isValidElement(children)) {
return null;
Expand All@@ -64,6 +66,7 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
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();
Expand All@@ -90,11 +93,7 @@ export const MenuList = (props: MenuListProps) => {
const { popoverCtx, elementId } = useMenuState();
const { floating, styles, isOpen, context, nodeId } = popoverCtx;
const containerRef = useRef<HTMLDivElement | null>(null);

useLayoutEffect(() => {
const current = containerRef.current;
floating(current);
}, [isOpen]);
const mergedRef = useMergeRefs([containerRef, floating]);

const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
const current = containerRef.current;
Expand DownExpand Up@@ -122,7 +121,7 @@ export const MenuList = (props: MenuListProps) => {
<Col
elementDescriptor={descriptors.menuList}
elementId={descriptors.menuList.setId(elementId)}
ref={containerRef}
ref={mergedRef}
role='menu'
onKeyDown={onKeyDown}
sx={[
Expand Down
74 changes: 67 additions & 7 deletions packages/ui/src/elements/Select.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ type SelectState<O extends Option> = Pick<
select: (option: O) => void;
focusedItemRef: React.RefObject<HTMLDivElement>;
onTriggerClick: () => void;
generatedTriggerId: string;
triggerId: string;
setTriggerId: React.Dispatch<React.SetStateAction<string>>;
generatedListboxId: string;
listboxId: string;
setListboxId: React.Dispatch<React.SetStateAction<string>>;
portal?: boolean;
};

Expand DownExpand Up@@ -97,11 +103,17 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
} = props;
const popoverCtx = usePopover({
autoUpdate: true,
adjustToReferenceWidth: !!referenceElement,
// +2px compensates for the 1px border on each side of the trigger
adjustToReferenceWidth: 2,
referenceElement: referenceElement,
offset: { mainAxis: 6, crossAxis: -1 },
});
const togglePopover = popoverCtx.toggle;
const focusedItemRef = React.useRef<HTMLDivElement>(null);
const generatedTriggerId = React.useId();
const generatedListboxId = React.useId();
const [triggerId, setTriggerId] = React.useState(generatedTriggerId);
const [listboxId, setListboxId] = React.useState(generatedListboxId);
const searchInputCtx = useSearchInput({
items: options,
comparator: comparator || (() => true),
Expand DownExpand Up@@ -139,6 +151,12 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
comparator,
select,
onTriggerClick: togglePopover,
generatedTriggerId,
triggerId,
setTriggerId,
generatedListboxId,
listboxId,
setListboxId,
elementId,
portal,
},
Expand DownExpand Up@@ -167,6 +185,8 @@ const SelectRenderOption = React.memo(
return (
<Flex
ref={ref}
role='option'
aria-selected={isSelected}
sx={{
userSelect: 'none',
cursor: 'pointer',
Expand DownExpand Up@@ -240,7 +260,16 @@ type SelectOptionListProps = PropsOfComponent<typeof Flex> & {
};

export const SelectOptionList = (props: SelectOptionListProps) => {
const { containerSx, sx, footer, onReachEnd, ...rest } = props;
const {
containerSx,
sx,
footer,
onReachEnd,
id,
'aria-label': ariaLabel,
'aria-labelledby': ariaLabelledBy,
...rest
} = props;
const {
popoverCtx,
searchInputCtx,
Expand All@@ -253,12 +282,21 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
select,
onTriggerClick,
elementId,
triggerId,
generatedListboxId,
setListboxId,
portal,
} = useSelectState();
const { filteredItems: options, searchInputProps } = searchInputCtx;
const [focusedIndex, setFocusedIndex] = useState(0);
const { isOpen, floating, styles, nodeId, context } = popoverCtx;
const containerRef = React.useRef<HTMLDivElement>(null);
const effectiveListboxId = id ?? generatedListboxId;
const effectiveAriaLabelledBy = ariaLabelledBy ?? (ariaLabel ? undefined : triggerId);

React.useEffect(() => {
setListboxId(effectiveListboxId);
}, [effectiveListboxId, setListboxId]);

const scrollToItemOnSelectedIndexChange = () => {
if (!isOpen) {
Expand DownExpand Up@@ -338,8 +376,7 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
}),
sx,
]}
// eslint-disable-next-line custom-rules/no-physical-css-properties -- Floating UI library positioning
style={{ ...styles, left: styles.left - 1 }}
style={styles}
>
{comparator && (
<SelectSearchbar
Expand All@@ -349,7 +386,11 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
)}
<Flex
ref={containerRef}
id={effectiveListboxId}
direction='col'
role='listbox'
aria-label={ariaLabel}
aria-labelledby={effectiveAriaLabelledBy}
tabIndex={comparator ? undefined : 0}
sx={[
theme => ({
Expand DownExpand Up@@ -395,9 +436,24 @@ export const SelectButton = (
iconSx?: ThemableCssProp;
},
) => {
const { sx, children, icon, iconSx, ...rest } = props;
const { popoverCtx, onTriggerClick, buttonRenderOption, selectedOption, placeholder, elementId } = useSelectState();
const { reference } = popoverCtx;
const { sx, children, icon, iconSx, id, 'aria-controls': ariaControls, ...rest } = props;
const {
popoverCtx,
onTriggerClick,
buttonRenderOption,
selectedOption,
placeholder,
elementId,
generatedTriggerId,
listboxId,
setTriggerId,
} = useSelectState();
const { reference, isOpen } = popoverCtx;
const effectiveTriggerId = id ?? generatedTriggerId;

React.useEffect(() => {
setTriggerId(effectiveTriggerId);
}, [effectiveTriggerId, setTriggerId]);

let show: React.ReactNode = children;
if (!children) {
Expand All@@ -409,9 +465,13 @@ export const SelectButton = (
elementDescriptor={descriptors.selectButton}
elementId={descriptors.selectButton.setId(elementId)}
ref={reference}
id={effectiveTriggerId}
variant='outline'
textVariant='buttonLarge'
onClick={onTriggerClick}
aria-expanded={isOpen}
aria-haspopup='listbox'
aria-controls={ariaControls ?? (isOpen ? listboxId : undefined)}
sx={[
theme => ({
gap: theme.space.$2,
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/elements/ThreeDotsMenu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

return (
<Menu elementId={elementId}>
<MenuTrigger arialLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<Button
sx={t =>
!isBordered
Expand Down
121 changes: 121 additions & 0 deletions packages/ui/src/elements/__tests__/Select.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { ClerkInstanceContext } from '@clerk/shared/react';
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import type { PropsWithChildren, ReactElement } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { EnvironmentProvider } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { InternalThemeProvider } from '../../styledSystem';
import { Select, SelectButton, SelectOptionList } from '../Select';

const options = [
{ value: 'one', label: 'One' },
{ value: 'two', label: 'Two' },
];

const TestProviders = ({ children }: PropsWithChildren) => (
<ClerkInstanceContext.Provider value={{ value: { client: {}, user: {} } as any }}>
<EnvironmentProvider value={{ displayConfig: { applicationName: 'TestApp' } } as any}>
<AppearanceProvider>
<InternalThemeProvider>{children}</InternalThemeProvider>
</AppearanceProvider>
</EnvironmentProvider>
</ClerkInstanceContext.Provider>
);

const renderSelect = (ui: ReactElement) => {
return render(ui, { wrapper: TestProviders });
};

describe('Select', () => {
it('labels the listbox with the generated trigger id by default', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
/>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(button).toHaveAttribute('id');
expect(listbox).toHaveAttribute('id');
expect(listbox).toHaveAttribute('aria-labelledby', button.id);
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('labels the listbox with an explicit trigger id', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton id='expiration-field' />
<SelectOptionList />
</Select>,
);

const button = document.getElementById('expiration-field') as HTMLButtonElement;

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(listbox).toHaveAttribute('aria-labelledby', 'expiration-field');
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('preserves an explicit listbox aria-label', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton />
<SelectOptionList aria-label='Expiration options' />
</Select>,
);

await user.click(screen.getByRole('button', { name: 'Select an option' }));

const listbox = await screen.findByRole('listbox', { name: 'Expiration options' });

expect(listbox).toHaveAttribute('aria-label', 'Expiration options');
expect(listbox).not.toHaveAttribute('aria-labelledby');
});

it('preserves an explicit listbox aria-labelledby', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<span id='external-label'>External options</span>
<SelectButton />
<SelectOptionList aria-labelledby='external-label' />
</Select>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox', { name: 'External options' });

expect(listbox).toHaveAttribute('aria-labelledby', 'external-label');
expect(listbox).not.toHaveAttribute('aria-labelledby', button.id);
});
});
7 changes: 4 additions & 3 deletions packages/ui/src/hooks/usePopover.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ type UsePopoverProps = {
shoudFlip?: boolean;
autoUpdate?: boolean;
outsidePress?: boolean | ((event: MouseEvent) => boolean);
adjustToReferenceWidth?: boolean;
adjustToReferenceWidth?: boolean | number;
referenceElement?: React.RefObject<HTMLElement> | null;
canCloseModal?: boolean;
bubbles?:
Expand DownExpand Up@@ -60,9 +60,10 @@ export const usePopover = (props: UsePopoverProps = {}): UsePopoverReturn => {
shift(),
size({
apply({ elements }) {
if (adjustToReferenceWidth) {
if (typeof adjustToReferenceWidth === 'number' || adjustToReferenceWidth === true) {
const reference = elements.reference as any as HTMLElement;
elements.floating.style.width = reference ? `${reference?.offsetWidth}px` : '';
const extra = typeof adjustToReferenceWidth === 'number' ? adjustToReferenceWidth : 0;
elements.floating.style.width = reference ? `${reference.offsetWidth + extra}px` : '';
}
},
}),
Expand Down
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('^' + ".*" + ' fix(ui): Improve Floating UI usage by alexcarpenter · Pull Request #8328 · clerk/javascript · GitHub
Skip to content
Merged
5 changes: 5 additions & 0 deletions .changeset/floating-ui-aria-fixes.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Floating UI usage: fix `arialLabel` typo in `MenuTrigger`, replace imperative floating ref in `MenuList` with `useMergeRefs`, remove manual position offset in `SelectOptionList`, add `aria-haspopup` to `MenuTrigger`, and add missing ARIA attributes (`aria-expanded`, `aria-haspopup`, `role`, `aria-selected`) to `Select` components.
19 changes: 9 additions & 10 deletions packages/ui/src/elements/Menu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@ import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useLayoutEffect, useRef } 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';
Expand DownExpand Up@@ -44,14 +46,14 @@ export const Menu = withFloatingTree((props: MenuProps) => {
);
});

type MenuTriggerProps = React.PropsWithChildren<{ arialLabel?: string | ((open: boolean) => string) }>;
type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: boolean) => string) }>;

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

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

if (!isValidElement(children)) {
return null;
Expand All@@ -64,6 +66,7 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
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();
Expand All@@ -90,11 +93,7 @@ export const MenuList = (props: MenuListProps) => {
const { popoverCtx, elementId } = useMenuState();
const { floating, styles, isOpen, context, nodeId } = popoverCtx;
const containerRef = useRef<HTMLDivElement | null>(null);

useLayoutEffect(() => {
const current = containerRef.current;
floating(current);
}, [isOpen]);
const mergedRef = useMergeRefs([containerRef, floating]);

const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
const current = containerRef.current;
Expand DownExpand Up@@ -122,7 +121,7 @@ export const MenuList = (props: MenuListProps) => {
<Col
elementDescriptor={descriptors.menuList}
elementId={descriptors.menuList.setId(elementId)}
ref={containerRef}
ref={mergedRef}
role='menu'
onKeyDown={onKeyDown}
sx={[
Expand Down
74 changes: 67 additions & 7 deletions packages/ui/src/elements/Select.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ type SelectState<O extends Option> = Pick<
select: (option: O) => void;
focusedItemRef: React.RefObject<HTMLDivElement>;
onTriggerClick: () => void;
generatedTriggerId: string;
triggerId: string;
setTriggerId: React.Dispatch<React.SetStateAction<string>>;
generatedListboxId: string;
listboxId: string;
setListboxId: React.Dispatch<React.SetStateAction<string>>;
portal?: boolean;
};

Expand DownExpand Up@@ -97,11 +103,17 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
} = props;
const popoverCtx = usePopover({
autoUpdate: true,
adjustToReferenceWidth: !!referenceElement,
// +2px compensates for the 1px border on each side of the trigger
adjustToReferenceWidth: 2,
referenceElement: referenceElement,
offset: { mainAxis: 6, crossAxis: -1 },
});
const togglePopover = popoverCtx.toggle;
const focusedItemRef = React.useRef<HTMLDivElement>(null);
const generatedTriggerId = React.useId();
const generatedListboxId = React.useId();
const [triggerId, setTriggerId] = React.useState(generatedTriggerId);
const [listboxId, setListboxId] = React.useState(generatedListboxId);
const searchInputCtx = useSearchInput({
items: options,
comparator: comparator || (() => true),
Expand DownExpand Up@@ -139,6 +151,12 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
comparator,
select,
onTriggerClick: togglePopover,
generatedTriggerId,
triggerId,
setTriggerId,
generatedListboxId,
listboxId,
setListboxId,
elementId,
portal,
},
Expand DownExpand Up@@ -167,6 +185,8 @@ const SelectRenderOption = React.memo(
return (
<Flex
ref={ref}
role='option'
aria-selected={isSelected}
sx={{
userSelect: 'none',
cursor: 'pointer',
Expand DownExpand Up@@ -240,7 +260,16 @@ type SelectOptionListProps = PropsOfComponent<typeof Flex> & {
};

export const SelectOptionList = (props: SelectOptionListProps) => {
const { containerSx, sx, footer, onReachEnd, ...rest } = props;
const {
containerSx,
sx,
footer,
onReachEnd,
id,
'aria-label': ariaLabel,
'aria-labelledby': ariaLabelledBy,
...rest
} = props;
const {
popoverCtx,
searchInputCtx,
Expand All@@ -253,12 +282,21 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
select,
onTriggerClick,
elementId,
triggerId,
generatedListboxId,
setListboxId,
portal,
} = useSelectState();
const { filteredItems: options, searchInputProps } = searchInputCtx;
const [focusedIndex, setFocusedIndex] = useState(0);
const { isOpen, floating, styles, nodeId, context } = popoverCtx;
const containerRef = React.useRef<HTMLDivElement>(null);
const effectiveListboxId = id ?? generatedListboxId;
const effectiveAriaLabelledBy = ariaLabelledBy ?? (ariaLabel ? undefined : triggerId);

React.useEffect(() => {
setListboxId(effectiveListboxId);
}, [effectiveListboxId, setListboxId]);

const scrollToItemOnSelectedIndexChange = () => {
if (!isOpen) {
Expand DownExpand Up@@ -338,8 +376,7 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
}),
sx,
]}
// eslint-disable-next-line custom-rules/no-physical-css-properties -- Floating UI library positioning
style={{ ...styles, left: styles.left - 1 }}
style={styles}
>
{comparator && (
<SelectSearchbar
Expand All@@ -349,7 +386,11 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
)}
<Flex
ref={containerRef}
id={effectiveListboxId}
direction='col'
role='listbox'
aria-label={ariaLabel}
aria-labelledby={effectiveAriaLabelledBy}
tabIndex={comparator ? undefined : 0}
sx={[
theme => ({
Expand DownExpand Up@@ -395,9 +436,24 @@ export const SelectButton = (
iconSx?: ThemableCssProp;
},
) => {
const { sx, children, icon, iconSx, ...rest } = props;
const { popoverCtx, onTriggerClick, buttonRenderOption, selectedOption, placeholder, elementId } = useSelectState();
const { reference } = popoverCtx;
const { sx, children, icon, iconSx, id, 'aria-controls': ariaControls, ...rest } = props;
const {
popoverCtx,
onTriggerClick,
buttonRenderOption,
selectedOption,
placeholder,
elementId,
generatedTriggerId,
listboxId,
setTriggerId,
} = useSelectState();
const { reference, isOpen } = popoverCtx;
const effectiveTriggerId = id ?? generatedTriggerId;

React.useEffect(() => {
setTriggerId(effectiveTriggerId);
}, [effectiveTriggerId, setTriggerId]);

let show: React.ReactNode = children;
if (!children) {
Expand All@@ -409,9 +465,13 @@ export const SelectButton = (
elementDescriptor={descriptors.selectButton}
elementId={descriptors.selectButton.setId(elementId)}
ref={reference}
id={effectiveTriggerId}
variant='outline'
textVariant='buttonLarge'
onClick={onTriggerClick}
aria-expanded={isOpen}
aria-haspopup='listbox'
aria-controls={ariaControls ?? (isOpen ? listboxId : undefined)}
sx={[
theme => ({
gap: theme.space.$2,
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/elements/ThreeDotsMenu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

return (
<Menu elementId={elementId}>
<MenuTrigger arialLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<Button
sx={t =>
!isBordered
Expand Down
121 changes: 121 additions & 0 deletions packages/ui/src/elements/__tests__/Select.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { ClerkInstanceContext } from '@clerk/shared/react';
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import type { PropsWithChildren, ReactElement } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { EnvironmentProvider } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { InternalThemeProvider } from '../../styledSystem';
import { Select, SelectButton, SelectOptionList } from '../Select';

const options = [
{ value: 'one', label: 'One' },
{ value: 'two', label: 'Two' },
];

const TestProviders = ({ children }: PropsWithChildren) => (
<ClerkInstanceContext.Provider value={{ value: { client: {}, user: {} } as any }}>
<EnvironmentProvider value={{ displayConfig: { applicationName: 'TestApp' } } as any}>
<AppearanceProvider>
<InternalThemeProvider>{children}</InternalThemeProvider>
</AppearanceProvider>
</EnvironmentProvider>
</ClerkInstanceContext.Provider>
);

const renderSelect = (ui: ReactElement) => {
return render(ui, { wrapper: TestProviders });
};

describe('Select', () => {
it('labels the listbox with the generated trigger id by default', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
/>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(button).toHaveAttribute('id');
expect(listbox).toHaveAttribute('id');
expect(listbox).toHaveAttribute('aria-labelledby', button.id);
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('labels the listbox with an explicit trigger id', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton id='expiration-field' />
<SelectOptionList />
</Select>,
);

const button = document.getElementById('expiration-field') as HTMLButtonElement;

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(listbox).toHaveAttribute('aria-labelledby', 'expiration-field');
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('preserves an explicit listbox aria-label', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton />
<SelectOptionList aria-label='Expiration options' />
</Select>,
);

await user.click(screen.getByRole('button', { name: 'Select an option' }));

const listbox = await screen.findByRole('listbox', { name: 'Expiration options' });

expect(listbox).toHaveAttribute('aria-label', 'Expiration options');
expect(listbox).not.toHaveAttribute('aria-labelledby');
});

it('preserves an explicit listbox aria-labelledby', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<span id='external-label'>External options</span>
<SelectButton />
<SelectOptionList aria-labelledby='external-label' />
</Select>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox', { name: 'External options' });

expect(listbox).toHaveAttribute('aria-labelledby', 'external-label');
expect(listbox).not.toHaveAttribute('aria-labelledby', button.id);
});
});
7 changes: 4 additions & 3 deletions packages/ui/src/hooks/usePopover.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ type UsePopoverProps = {
shoudFlip?: boolean;
autoUpdate?: boolean;
outsidePress?: boolean | ((event: MouseEvent) => boolean);
adjustToReferenceWidth?: boolean;
adjustToReferenceWidth?: boolean | number;
referenceElement?: React.RefObject<HTMLElement> | null;
canCloseModal?: boolean;
bubbles?:
Expand DownExpand Up@@ -60,9 +60,10 @@ export const usePopover = (props: UsePopoverProps = {}): UsePopoverReturn => {
shift(),
size({
apply({ elements }) {
if (adjustToReferenceWidth) {
if (typeof adjustToReferenceWidth === 'number' || adjustToReferenceWidth === true) {
const reference = elements.reference as any as HTMLElement;
elements.floating.style.width = reference ? `${reference?.offsetWidth}px` : '';
const extra = typeof adjustToReferenceWidth === 'number' ? adjustToReferenceWidth : 0;
elements.floating.style.width = reference ? `${reference.offsetWidth + extra}px` : '';
}
},
}),
Expand Down
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" + ' fix(ui): Improve Floating UI usage by alexcarpenter · Pull Request #8328 · clerk/javascript · GitHub
Skip to content
Merged
5 changes: 5 additions & 0 deletions .changeset/floating-ui-aria-fixes.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Floating UI usage: fix `arialLabel` typo in `MenuTrigger`, replace imperative floating ref in `MenuList` with `useMergeRefs`, remove manual position offset in `SelectOptionList`, add `aria-haspopup` to `MenuTrigger`, and add missing ARIA attributes (`aria-expanded`, `aria-haspopup`, `role`, `aria-selected`) to `Select` components.
19 changes: 9 additions & 10 deletions packages/ui/src/elements/Menu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@ import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useLayoutEffect, useRef } 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';
Expand DownExpand Up@@ -44,14 +46,14 @@ export const Menu = withFloatingTree((props: MenuProps) => {
);
});

type MenuTriggerProps = React.PropsWithChildren<{ arialLabel?: string | ((open: boolean) => string) }>;
type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: boolean) => string) }>;

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

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

if (!isValidElement(children)) {
return null;
Expand All@@ -64,6 +66,7 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
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();
Expand All@@ -90,11 +93,7 @@ export const MenuList = (props: MenuListProps) => {
const { popoverCtx, elementId } = useMenuState();
const { floating, styles, isOpen, context, nodeId } = popoverCtx;
const containerRef = useRef<HTMLDivElement | null>(null);

useLayoutEffect(() => {
const current = containerRef.current;
floating(current);
}, [isOpen]);
const mergedRef = useMergeRefs([containerRef, floating]);

const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
const current = containerRef.current;
Expand DownExpand Up@@ -122,7 +121,7 @@ export const MenuList = (props: MenuListProps) => {
<Col
elementDescriptor={descriptors.menuList}
elementId={descriptors.menuList.setId(elementId)}
ref={containerRef}
ref={mergedRef}
role='menu'
onKeyDown={onKeyDown}
sx={[
Expand Down
74 changes: 67 additions & 7 deletions packages/ui/src/elements/Select.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ type SelectState<O extends Option> = Pick<
select: (option: O) => void;
focusedItemRef: React.RefObject<HTMLDivElement>;
onTriggerClick: () => void;
generatedTriggerId: string;
triggerId: string;
setTriggerId: React.Dispatch<React.SetStateAction<string>>;
generatedListboxId: string;
listboxId: string;
setListboxId: React.Dispatch<React.SetStateAction<string>>;
portal?: boolean;
};

Expand DownExpand Up@@ -97,11 +103,17 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
} = props;
const popoverCtx = usePopover({
autoUpdate: true,
adjustToReferenceWidth: !!referenceElement,
// +2px compensates for the 1px border on each side of the trigger
adjustToReferenceWidth: 2,
referenceElement: referenceElement,
offset: { mainAxis: 6, crossAxis: -1 },
});
const togglePopover = popoverCtx.toggle;
const focusedItemRef = React.useRef<HTMLDivElement>(null);
const generatedTriggerId = React.useId();
const generatedListboxId = React.useId();
const [triggerId, setTriggerId] = React.useState(generatedTriggerId);
const [listboxId, setListboxId] = React.useState(generatedListboxId);
const searchInputCtx = useSearchInput({
items: options,
comparator: comparator || (() => true),
Expand DownExpand Up@@ -139,6 +151,12 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
comparator,
select,
onTriggerClick: togglePopover,
generatedTriggerId,
triggerId,
setTriggerId,
generatedListboxId,
listboxId,
setListboxId,
elementId,
portal,
},
Expand DownExpand Up@@ -167,6 +185,8 @@ const SelectRenderOption = React.memo(
return (
<Flex
ref={ref}
role='option'
aria-selected={isSelected}
sx={{
userSelect: 'none',
cursor: 'pointer',
Expand DownExpand Up@@ -240,7 +260,16 @@ type SelectOptionListProps = PropsOfComponent<typeof Flex> & {
};

export const SelectOptionList = (props: SelectOptionListProps) => {
const { containerSx, sx, footer, onReachEnd, ...rest } = props;
const {
containerSx,
sx,
footer,
onReachEnd,
id,
'aria-label': ariaLabel,
'aria-labelledby': ariaLabelledBy,
...rest
} = props;
const {
popoverCtx,
searchInputCtx,
Expand All@@ -253,12 +282,21 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
select,
onTriggerClick,
elementId,
triggerId,
generatedListboxId,
setListboxId,
portal,
} = useSelectState();
const { filteredItems: options, searchInputProps } = searchInputCtx;
const [focusedIndex, setFocusedIndex] = useState(0);
const { isOpen, floating, styles, nodeId, context } = popoverCtx;
const containerRef = React.useRef<HTMLDivElement>(null);
const effectiveListboxId = id ?? generatedListboxId;
const effectiveAriaLabelledBy = ariaLabelledBy ?? (ariaLabel ? undefined : triggerId);

React.useEffect(() => {
setListboxId(effectiveListboxId);
}, [effectiveListboxId, setListboxId]);

const scrollToItemOnSelectedIndexChange = () => {
if (!isOpen) {
Expand DownExpand Up@@ -338,8 +376,7 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
}),
sx,
]}
// eslint-disable-next-line custom-rules/no-physical-css-properties -- Floating UI library positioning
style={{ ...styles, left: styles.left - 1 }}
style={styles}
>
{comparator && (
<SelectSearchbar
Expand All@@ -349,7 +386,11 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
)}
<Flex
ref={containerRef}
id={effectiveListboxId}
direction='col'
role='listbox'
aria-label={ariaLabel}
aria-labelledby={effectiveAriaLabelledBy}
tabIndex={comparator ? undefined : 0}
sx={[
theme => ({
Expand DownExpand Up@@ -395,9 +436,24 @@ export const SelectButton = (
iconSx?: ThemableCssProp;
},
) => {
const { sx, children, icon, iconSx, ...rest } = props;
const { popoverCtx, onTriggerClick, buttonRenderOption, selectedOption, placeholder, elementId } = useSelectState();
const { reference } = popoverCtx;
const { sx, children, icon, iconSx, id, 'aria-controls': ariaControls, ...rest } = props;
const {
popoverCtx,
onTriggerClick,
buttonRenderOption,
selectedOption,
placeholder,
elementId,
generatedTriggerId,
listboxId,
setTriggerId,
} = useSelectState();
const { reference, isOpen } = popoverCtx;
const effectiveTriggerId = id ?? generatedTriggerId;

React.useEffect(() => {
setTriggerId(effectiveTriggerId);
}, [effectiveTriggerId, setTriggerId]);

let show: React.ReactNode = children;
if (!children) {
Expand All@@ -409,9 +465,13 @@ export const SelectButton = (
elementDescriptor={descriptors.selectButton}
elementId={descriptors.selectButton.setId(elementId)}
ref={reference}
id={effectiveTriggerId}
variant='outline'
textVariant='buttonLarge'
onClick={onTriggerClick}
aria-expanded={isOpen}
aria-haspopup='listbox'
aria-controls={ariaControls ?? (isOpen ? listboxId : undefined)}
sx={[
theme => ({
gap: theme.space.$2,
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/elements/ThreeDotsMenu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

return (
<Menu elementId={elementId}>
<MenuTrigger arialLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<Button
sx={t =>
!isBordered
Expand Down
121 changes: 121 additions & 0 deletions packages/ui/src/elements/__tests__/Select.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { ClerkInstanceContext } from '@clerk/shared/react';
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import type { PropsWithChildren, ReactElement } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { EnvironmentProvider } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { InternalThemeProvider } from '../../styledSystem';
import { Select, SelectButton, SelectOptionList } from '../Select';

const options = [
{ value: 'one', label: 'One' },
{ value: 'two', label: 'Two' },
];

const TestProviders = ({ children }: PropsWithChildren) => (
<ClerkInstanceContext.Provider value={{ value: { client: {}, user: {} } as any }}>
<EnvironmentProvider value={{ displayConfig: { applicationName: 'TestApp' } } as any}>
<AppearanceProvider>
<InternalThemeProvider>{children}</InternalThemeProvider>
</AppearanceProvider>
</EnvironmentProvider>
</ClerkInstanceContext.Provider>
);

const renderSelect = (ui: ReactElement) => {
return render(ui, { wrapper: TestProviders });
};

describe('Select', () => {
it('labels the listbox with the generated trigger id by default', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
/>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(button).toHaveAttribute('id');
expect(listbox).toHaveAttribute('id');
expect(listbox).toHaveAttribute('aria-labelledby', button.id);
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('labels the listbox with an explicit trigger id', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton id='expiration-field' />
<SelectOptionList />
</Select>,
);

const button = document.getElementById('expiration-field') as HTMLButtonElement;

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(listbox).toHaveAttribute('aria-labelledby', 'expiration-field');
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('preserves an explicit listbox aria-label', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton />
<SelectOptionList aria-label='Expiration options' />
</Select>,
);

await user.click(screen.getByRole('button', { name: 'Select an option' }));

const listbox = await screen.findByRole('listbox', { name: 'Expiration options' });

expect(listbox).toHaveAttribute('aria-label', 'Expiration options');
expect(listbox).not.toHaveAttribute('aria-labelledby');
});

it('preserves an explicit listbox aria-labelledby', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<span id='external-label'>External options</span>
<SelectButton />
<SelectOptionList aria-labelledby='external-label' />
</Select>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox', { name: 'External options' });

expect(listbox).toHaveAttribute('aria-labelledby', 'external-label');
expect(listbox).not.toHaveAttribute('aria-labelledby', button.id);
});
});
7 changes: 4 additions & 3 deletions packages/ui/src/hooks/usePopover.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ type UsePopoverProps = {
shoudFlip?: boolean;
autoUpdate?: boolean;
outsidePress?: boolean | ((event: MouseEvent) => boolean);
adjustToReferenceWidth?: boolean;
adjustToReferenceWidth?: boolean | number;
referenceElement?: React.RefObject<HTMLElement> | null;
canCloseModal?: boolean;
bubbles?:
Expand DownExpand Up@@ -60,9 +60,10 @@ export const usePopover = (props: UsePopoverProps = {}): UsePopoverReturn => {
shift(),
size({
apply({ elements }) {
if (adjustToReferenceWidth) {
if (typeof adjustToReferenceWidth === 'number' || adjustToReferenceWidth === true) {
const reference = elements.reference as any as HTMLElement;
elements.floating.style.width = reference ? `${reference?.offsetWidth}px` : '';
const extra = typeof adjustToReferenceWidth === 'number' ? adjustToReferenceWidth : 0;
elements.floating.style.width = reference ? `${reference.offsetWidth + extra}px` : '';
}
},
}),
Expand Down
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('^' + ".*" + ' fix(ui): Improve Floating UI usage by alexcarpenter · Pull Request #8328 · clerk/javascript · GitHub
Skip to content
Merged
5 changes: 5 additions & 0 deletions .changeset/floating-ui-aria-fixes.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Floating UI usage: fix `arialLabel` typo in `MenuTrigger`, replace imperative floating ref in `MenuList` with `useMergeRefs`, remove manual position offset in `SelectOptionList`, add `aria-haspopup` to `MenuTrigger`, and add missing ARIA attributes (`aria-expanded`, `aria-haspopup`, `role`, `aria-selected`) to `Select` components.
19 changes: 9 additions & 10 deletions packages/ui/src/elements/Menu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@ import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useLayoutEffect, useRef } 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';
Expand DownExpand Up@@ -44,14 +46,14 @@ export const Menu = withFloatingTree((props: MenuProps) => {
);
});

type MenuTriggerProps = React.PropsWithChildren<{ arialLabel?: string | ((open: boolean) => string) }>;
type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: boolean) => string) }>;

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

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

if (!isValidElement(children)) {
return null;
Expand All@@ -64,6 +66,7 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
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();
Expand All@@ -90,11 +93,7 @@ export const MenuList = (props: MenuListProps) => {
const { popoverCtx, elementId } = useMenuState();
const { floating, styles, isOpen, context, nodeId } = popoverCtx;
const containerRef = useRef<HTMLDivElement | null>(null);

useLayoutEffect(() => {
const current = containerRef.current;
floating(current);
}, [isOpen]);
const mergedRef = useMergeRefs([containerRef, floating]);

const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
const current = containerRef.current;
Expand DownExpand Up@@ -122,7 +121,7 @@ export const MenuList = (props: MenuListProps) => {
<Col
elementDescriptor={descriptors.menuList}
elementId={descriptors.menuList.setId(elementId)}
ref={containerRef}
ref={mergedRef}
role='menu'
onKeyDown={onKeyDown}
sx={[
Expand Down
74 changes: 67 additions & 7 deletions packages/ui/src/elements/Select.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ type SelectState<O extends Option> = Pick<
select: (option: O) => void;
focusedItemRef: React.RefObject<HTMLDivElement>;
onTriggerClick: () => void;
generatedTriggerId: string;
triggerId: string;
setTriggerId: React.Dispatch<React.SetStateAction<string>>;
generatedListboxId: string;
listboxId: string;
setListboxId: React.Dispatch<React.SetStateAction<string>>;
portal?: boolean;
};

Expand DownExpand Up@@ -97,11 +103,17 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
} = props;
const popoverCtx = usePopover({
autoUpdate: true,
adjustToReferenceWidth: !!referenceElement,
// +2px compensates for the 1px border on each side of the trigger
adjustToReferenceWidth: 2,
referenceElement: referenceElement,
offset: { mainAxis: 6, crossAxis: -1 },
});
const togglePopover = popoverCtx.toggle;
const focusedItemRef = React.useRef<HTMLDivElement>(null);
const generatedTriggerId = React.useId();
const generatedListboxId = React.useId();
const [triggerId, setTriggerId] = React.useState(generatedTriggerId);
const [listboxId, setListboxId] = React.useState(generatedListboxId);
const searchInputCtx = useSearchInput({
items: options,
comparator: comparator || (() => true),
Expand DownExpand Up@@ -139,6 +151,12 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
comparator,
select,
onTriggerClick: togglePopover,
generatedTriggerId,
triggerId,
setTriggerId,
generatedListboxId,
listboxId,
setListboxId,
elementId,
portal,
},
Expand DownExpand Up@@ -167,6 +185,8 @@ const SelectRenderOption = React.memo(
return (
<Flex
ref={ref}
role='option'
aria-selected={isSelected}
sx={{
userSelect: 'none',
cursor: 'pointer',
Expand DownExpand Up@@ -240,7 +260,16 @@ type SelectOptionListProps = PropsOfComponent<typeof Flex> & {
};

export const SelectOptionList = (props: SelectOptionListProps) => {
const { containerSx, sx, footer, onReachEnd, ...rest } = props;
const {
containerSx,
sx,
footer,
onReachEnd,
id,
'aria-label': ariaLabel,
'aria-labelledby': ariaLabelledBy,
...rest
} = props;
const {
popoverCtx,
searchInputCtx,
Expand All@@ -253,12 +282,21 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
select,
onTriggerClick,
elementId,
triggerId,
generatedListboxId,
setListboxId,
portal,
} = useSelectState();
const { filteredItems: options, searchInputProps } = searchInputCtx;
const [focusedIndex, setFocusedIndex] = useState(0);
const { isOpen, floating, styles, nodeId, context } = popoverCtx;
const containerRef = React.useRef<HTMLDivElement>(null);
const effectiveListboxId = id ?? generatedListboxId;
const effectiveAriaLabelledBy = ariaLabelledBy ?? (ariaLabel ? undefined : triggerId);

React.useEffect(() => {
setListboxId(effectiveListboxId);
}, [effectiveListboxId, setListboxId]);

const scrollToItemOnSelectedIndexChange = () => {
if (!isOpen) {
Expand DownExpand Up@@ -338,8 +376,7 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
}),
sx,
]}
// eslint-disable-next-line custom-rules/no-physical-css-properties -- Floating UI library positioning
style={{ ...styles, left: styles.left - 1 }}
style={styles}
>
{comparator && (
<SelectSearchbar
Expand All@@ -349,7 +386,11 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
)}
<Flex
ref={containerRef}
id={effectiveListboxId}
direction='col'
role='listbox'
aria-label={ariaLabel}
aria-labelledby={effectiveAriaLabelledBy}
tabIndex={comparator ? undefined : 0}
sx={[
theme => ({
Expand DownExpand Up@@ -395,9 +436,24 @@ export const SelectButton = (
iconSx?: ThemableCssProp;
},
) => {
const { sx, children, icon, iconSx, ...rest } = props;
const { popoverCtx, onTriggerClick, buttonRenderOption, selectedOption, placeholder, elementId } = useSelectState();
const { reference } = popoverCtx;
const { sx, children, icon, iconSx, id, 'aria-controls': ariaControls, ...rest } = props;
const {
popoverCtx,
onTriggerClick,
buttonRenderOption,
selectedOption,
placeholder,
elementId,
generatedTriggerId,
listboxId,
setTriggerId,
} = useSelectState();
const { reference, isOpen } = popoverCtx;
const effectiveTriggerId = id ?? generatedTriggerId;

React.useEffect(() => {
setTriggerId(effectiveTriggerId);
}, [effectiveTriggerId, setTriggerId]);

let show: React.ReactNode = children;
if (!children) {
Expand All@@ -409,9 +465,13 @@ export const SelectButton = (
elementDescriptor={descriptors.selectButton}
elementId={descriptors.selectButton.setId(elementId)}
ref={reference}
id={effectiveTriggerId}
variant='outline'
textVariant='buttonLarge'
onClick={onTriggerClick}
aria-expanded={isOpen}
aria-haspopup='listbox'
aria-controls={ariaControls ?? (isOpen ? listboxId : undefined)}
sx={[
theme => ({
gap: theme.space.$2,
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/elements/ThreeDotsMenu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

return (
<Menu elementId={elementId}>
<MenuTrigger arialLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<Button
sx={t =>
!isBordered
Expand Down
121 changes: 121 additions & 0 deletions packages/ui/src/elements/__tests__/Select.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { ClerkInstanceContext } from '@clerk/shared/react';
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import type { PropsWithChildren, ReactElement } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { EnvironmentProvider } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { InternalThemeProvider } from '../../styledSystem';
import { Select, SelectButton, SelectOptionList } from '../Select';

const options = [
{ value: 'one', label: 'One' },
{ value: 'two', label: 'Two' },
];

const TestProviders = ({ children }: PropsWithChildren) => (
<ClerkInstanceContext.Provider value={{ value: { client: {}, user: {} } as any }}>
<EnvironmentProvider value={{ displayConfig: { applicationName: 'TestApp' } } as any}>
<AppearanceProvider>
<InternalThemeProvider>{children}</InternalThemeProvider>
</AppearanceProvider>
</EnvironmentProvider>
</ClerkInstanceContext.Provider>
);

const renderSelect = (ui: ReactElement) => {
return render(ui, { wrapper: TestProviders });
};

describe('Select', () => {
it('labels the listbox with the generated trigger id by default', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
/>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(button).toHaveAttribute('id');
expect(listbox).toHaveAttribute('id');
expect(listbox).toHaveAttribute('aria-labelledby', button.id);
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('labels the listbox with an explicit trigger id', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton id='expiration-field' />
<SelectOptionList />
</Select>,
);

const button = document.getElementById('expiration-field') as HTMLButtonElement;

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(listbox).toHaveAttribute('aria-labelledby', 'expiration-field');
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('preserves an explicit listbox aria-label', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton />
<SelectOptionList aria-label='Expiration options' />
</Select>,
);

await user.click(screen.getByRole('button', { name: 'Select an option' }));

const listbox = await screen.findByRole('listbox', { name: 'Expiration options' });

expect(listbox).toHaveAttribute('aria-label', 'Expiration options');
expect(listbox).not.toHaveAttribute('aria-labelledby');
});

it('preserves an explicit listbox aria-labelledby', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<span id='external-label'>External options</span>
<SelectButton />
<SelectOptionList aria-labelledby='external-label' />
</Select>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox', { name: 'External options' });

expect(listbox).toHaveAttribute('aria-labelledby', 'external-label');
expect(listbox).not.toHaveAttribute('aria-labelledby', button.id);
});
});
7 changes: 4 additions & 3 deletions packages/ui/src/hooks/usePopover.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ type UsePopoverProps = {
shoudFlip?: boolean;
autoUpdate?: boolean;
outsidePress?: boolean | ((event: MouseEvent) => boolean);
adjustToReferenceWidth?: boolean;
adjustToReferenceWidth?: boolean | number;
referenceElement?: React.RefObject<HTMLElement> | null;
canCloseModal?: boolean;
bubbles?:
Expand DownExpand Up@@ -60,9 +60,10 @@ export const usePopover = (props: UsePopoverProps = {}): UsePopoverReturn => {
shift(),
size({
apply({ elements }) {
if (adjustToReferenceWidth) {
if (typeof adjustToReferenceWidth === 'number' || adjustToReferenceWidth === true) {
const reference = elements.reference as any as HTMLElement;
elements.floating.style.width = reference ? `${reference?.offsetWidth}px` : '';
const extra = typeof adjustToReferenceWidth === 'number' ? adjustToReferenceWidth : 0;
elements.floating.style.width = reference ? `${reference.offsetWidth + extra}px` : '';
}
},
}),
Expand Down
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('^' + ".*" + ' fix(ui): Improve Floating UI usage by alexcarpenter · Pull Request #8328 · clerk/javascript · GitHub
Skip to content
Merged
5 changes: 5 additions & 0 deletions .changeset/floating-ui-aria-fixes.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Floating UI usage: fix `arialLabel` typo in `MenuTrigger`, replace imperative floating ref in `MenuList` with `useMergeRefs`, remove manual position offset in `SelectOptionList`, add `aria-haspopup` to `MenuTrigger`, and add missing ARIA attributes (`aria-expanded`, `aria-haspopup`, `role`, `aria-selected`) to `Select` components.
19 changes: 9 additions & 10 deletions packages/ui/src/elements/Menu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@ import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useLayoutEffect, useRef } 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';
Expand DownExpand Up@@ -44,14 +46,14 @@ export const Menu = withFloatingTree((props: MenuProps) => {
);
});

type MenuTriggerProps = React.PropsWithChildren<{ arialLabel?: string | ((open: boolean) => string) }>;
type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: boolean) => string) }>;

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

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

if (!isValidElement(children)) {
return null;
Expand All@@ -64,6 +66,7 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
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();
Expand All@@ -90,11 +93,7 @@ export const MenuList = (props: MenuListProps) => {
const { popoverCtx, elementId } = useMenuState();
const { floating, styles, isOpen, context, nodeId } = popoverCtx;
const containerRef = useRef<HTMLDivElement | null>(null);

useLayoutEffect(() => {
const current = containerRef.current;
floating(current);
}, [isOpen]);
const mergedRef = useMergeRefs([containerRef, floating]);

const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
const current = containerRef.current;
Expand DownExpand Up@@ -122,7 +121,7 @@ export const MenuList = (props: MenuListProps) => {
<Col
elementDescriptor={descriptors.menuList}
elementId={descriptors.menuList.setId(elementId)}
ref={containerRef}
ref={mergedRef}
role='menu'
onKeyDown={onKeyDown}
sx={[
Expand Down
74 changes: 67 additions & 7 deletions packages/ui/src/elements/Select.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ type SelectState<O extends Option> = Pick<
select: (option: O) => void;
focusedItemRef: React.RefObject<HTMLDivElement>;
onTriggerClick: () => void;
generatedTriggerId: string;
triggerId: string;
setTriggerId: React.Dispatch<React.SetStateAction<string>>;
generatedListboxId: string;
listboxId: string;
setListboxId: React.Dispatch<React.SetStateAction<string>>;
portal?: boolean;
};

Expand DownExpand Up@@ -97,11 +103,17 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
} = props;
const popoverCtx = usePopover({
autoUpdate: true,
adjustToReferenceWidth: !!referenceElement,
// +2px compensates for the 1px border on each side of the trigger
adjustToReferenceWidth: 2,
referenceElement: referenceElement,
offset: { mainAxis: 6, crossAxis: -1 },
});
const togglePopover = popoverCtx.toggle;
const focusedItemRef = React.useRef<HTMLDivElement>(null);
const generatedTriggerId = React.useId();
const generatedListboxId = React.useId();
const [triggerId, setTriggerId] = React.useState(generatedTriggerId);
const [listboxId, setListboxId] = React.useState(generatedListboxId);
const searchInputCtx = useSearchInput({
items: options,
comparator: comparator || (() => true),
Expand DownExpand Up@@ -139,6 +151,12 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
comparator,
select,
onTriggerClick: togglePopover,
generatedTriggerId,
triggerId,
setTriggerId,
generatedListboxId,
listboxId,
setListboxId,
elementId,
portal,
},
Expand DownExpand Up@@ -167,6 +185,8 @@ const SelectRenderOption = React.memo(
return (
<Flex
ref={ref}
role='option'
aria-selected={isSelected}
sx={{
userSelect: 'none',
cursor: 'pointer',
Expand DownExpand Up@@ -240,7 +260,16 @@ type SelectOptionListProps = PropsOfComponent<typeof Flex> & {
};

export const SelectOptionList = (props: SelectOptionListProps) => {
const { containerSx, sx, footer, onReachEnd, ...rest } = props;
const {
containerSx,
sx,
footer,
onReachEnd,
id,
'aria-label': ariaLabel,
'aria-labelledby': ariaLabelledBy,
...rest
} = props;
const {
popoverCtx,
searchInputCtx,
Expand All@@ -253,12 +282,21 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
select,
onTriggerClick,
elementId,
triggerId,
generatedListboxId,
setListboxId,
portal,
} = useSelectState();
const { filteredItems: options, searchInputProps } = searchInputCtx;
const [focusedIndex, setFocusedIndex] = useState(0);
const { isOpen, floating, styles, nodeId, context } = popoverCtx;
const containerRef = React.useRef<HTMLDivElement>(null);
const effectiveListboxId = id ?? generatedListboxId;
const effectiveAriaLabelledBy = ariaLabelledBy ?? (ariaLabel ? undefined : triggerId);

React.useEffect(() => {
setListboxId(effectiveListboxId);
}, [effectiveListboxId, setListboxId]);

const scrollToItemOnSelectedIndexChange = () => {
if (!isOpen) {
Expand DownExpand Up@@ -338,8 +376,7 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
}),
sx,
]}
// eslint-disable-next-line custom-rules/no-physical-css-properties -- Floating UI library positioning
style={{ ...styles, left: styles.left - 1 }}
style={styles}
>
{comparator && (
<SelectSearchbar
Expand All@@ -349,7 +386,11 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
)}
<Flex
ref={containerRef}
id={effectiveListboxId}
direction='col'
role='listbox'
aria-label={ariaLabel}
aria-labelledby={effectiveAriaLabelledBy}
tabIndex={comparator ? undefined : 0}
sx={[
theme => ({
Expand DownExpand Up@@ -395,9 +436,24 @@ export const SelectButton = (
iconSx?: ThemableCssProp;
},
) => {
const { sx, children, icon, iconSx, ...rest } = props;
const { popoverCtx, onTriggerClick, buttonRenderOption, selectedOption, placeholder, elementId } = useSelectState();
const { reference } = popoverCtx;
const { sx, children, icon, iconSx, id, 'aria-controls': ariaControls, ...rest } = props;
const {
popoverCtx,
onTriggerClick,
buttonRenderOption,
selectedOption,
placeholder,
elementId,
generatedTriggerId,
listboxId,
setTriggerId,
} = useSelectState();
const { reference, isOpen } = popoverCtx;
const effectiveTriggerId = id ?? generatedTriggerId;

React.useEffect(() => {
setTriggerId(effectiveTriggerId);
}, [effectiveTriggerId, setTriggerId]);

let show: React.ReactNode = children;
if (!children) {
Expand All@@ -409,9 +465,13 @@ export const SelectButton = (
elementDescriptor={descriptors.selectButton}
elementId={descriptors.selectButton.setId(elementId)}
ref={reference}
id={effectiveTriggerId}
variant='outline'
textVariant='buttonLarge'
onClick={onTriggerClick}
aria-expanded={isOpen}
aria-haspopup='listbox'
aria-controls={ariaControls ?? (isOpen ? listboxId : undefined)}
sx={[
theme => ({
gap: theme.space.$2,
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/elements/ThreeDotsMenu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

return (
<Menu elementId={elementId}>
<MenuTrigger arialLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<Button
sx={t =>
!isBordered
Expand Down
121 changes: 121 additions & 0 deletions packages/ui/src/elements/__tests__/Select.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { ClerkInstanceContext } from '@clerk/shared/react';
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import type { PropsWithChildren, ReactElement } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { EnvironmentProvider } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { InternalThemeProvider } from '../../styledSystem';
import { Select, SelectButton, SelectOptionList } from '../Select';

const options = [
{ value: 'one', label: 'One' },
{ value: 'two', label: 'Two' },
];

const TestProviders = ({ children }: PropsWithChildren) => (
<ClerkInstanceContext.Provider value={{ value: { client: {}, user: {} } as any }}>
<EnvironmentProvider value={{ displayConfig: { applicationName: 'TestApp' } } as any}>
<AppearanceProvider>
<InternalThemeProvider>{children}</InternalThemeProvider>
</AppearanceProvider>
</EnvironmentProvider>
</ClerkInstanceContext.Provider>
);

const renderSelect = (ui: ReactElement) => {
return render(ui, { wrapper: TestProviders });
};

describe('Select', () => {
it('labels the listbox with the generated trigger id by default', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
/>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(button).toHaveAttribute('id');
expect(listbox).toHaveAttribute('id');
expect(listbox).toHaveAttribute('aria-labelledby', button.id);
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('labels the listbox with an explicit trigger id', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton id='expiration-field' />
<SelectOptionList />
</Select>,
);

const button = document.getElementById('expiration-field') as HTMLButtonElement;

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(listbox).toHaveAttribute('aria-labelledby', 'expiration-field');
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('preserves an explicit listbox aria-label', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton />
<SelectOptionList aria-label='Expiration options' />
</Select>,
);

await user.click(screen.getByRole('button', { name: 'Select an option' }));

const listbox = await screen.findByRole('listbox', { name: 'Expiration options' });

expect(listbox).toHaveAttribute('aria-label', 'Expiration options');
expect(listbox).not.toHaveAttribute('aria-labelledby');
});

it('preserves an explicit listbox aria-labelledby', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<span id='external-label'>External options</span>
<SelectButton />
<SelectOptionList aria-labelledby='external-label' />
</Select>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox', { name: 'External options' });

expect(listbox).toHaveAttribute('aria-labelledby', 'external-label');
expect(listbox).not.toHaveAttribute('aria-labelledby', button.id);
});
});
7 changes: 4 additions & 3 deletions packages/ui/src/hooks/usePopover.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ type UsePopoverProps = {
shoudFlip?: boolean;
autoUpdate?: boolean;
outsidePress?: boolean | ((event: MouseEvent) => boolean);
adjustToReferenceWidth?: boolean;
adjustToReferenceWidth?: boolean | number;
referenceElement?: React.RefObject<HTMLElement> | null;
canCloseModal?: boolean;
bubbles?:
Expand DownExpand Up@@ -60,9 +60,10 @@ export const usePopover = (props: UsePopoverProps = {}): UsePopoverReturn => {
shift(),
size({
apply({ elements }) {
if (adjustToReferenceWidth) {
if (typeof adjustToReferenceWidth === 'number' || adjustToReferenceWidth === true) {
const reference = elements.reference as any as HTMLElement;
elements.floating.style.width = reference ? `${reference?.offsetWidth}px` : '';
const extra = typeof adjustToReferenceWidth === 'number' ? adjustToReferenceWidth : 0;
elements.floating.style.width = reference ? `${reference.offsetWidth + extra}px` : '';
}
},
}),
Expand Down
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); } })(); })(); fix(ui): Improve Floating UI usage by alexcarpenter · Pull Request #8328 · clerk/javascript · GitHub
Skip to content
Merged
5 changes: 5 additions & 0 deletions .changeset/floating-ui-aria-fixes.md
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
---
'@clerk/ui': patch
---

Improve Floating UI usage: fix `arialLabel` typo in `MenuTrigger`, replace imperative floating ref in `MenuList` with `useMergeRefs`, remove manual position offset in `SelectOptionList`, add `aria-haspopup` to `MenuTrigger`, and add missing ARIA attributes (`aria-expanded`, `aria-haspopup`, `role`, `aria-selected`) to `Select` components.
19 changes: 9 additions & 10 deletions packages/ui/src/elements/Menu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,9 @@ import { createContextAndHook } from '@clerk/shared/react';
import type { MenuId } from '@clerk/shared/types';
import type { Placement } from '@floating-ui/react';
import type { PropsWithChildren } from 'react';
import React, { cloneElement, isValidElement, useLayoutEffect, useRef } 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';
Expand DownExpand Up@@ -44,14 +46,14 @@ export const Menu = withFloatingTree((props: MenuProps) => {
);
});

type MenuTriggerProps = React.PropsWithChildren<{ arialLabel?: string | ((open: boolean) => string) }>;
type MenuTriggerProps = React.PropsWithChildren<{ ariaLabel?: string | ((open: boolean) => string) }>;

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

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

if (!isValidElement(children)) {
return null;
Expand All@@ -64,6 +66,7 @@ export const MenuTrigger = (props: MenuTriggerProps) => {
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();
Expand All@@ -90,11 +93,7 @@ export const MenuList = (props: MenuListProps) => {
const { popoverCtx, elementId } = useMenuState();
const { floating, styles, isOpen, context, nodeId } = popoverCtx;
const containerRef = useRef<HTMLDivElement | null>(null);

useLayoutEffect(() => {
const current = containerRef.current;
floating(current);
}, [isOpen]);
const mergedRef = useMergeRefs([containerRef, floating]);

const onKeyDown = (e: React.KeyboardEvent<HTMLDivElement>) => {
const current = containerRef.current;
Expand DownExpand Up@@ -122,7 +121,7 @@ export const MenuList = (props: MenuListProps) => {
<Col
elementDescriptor={descriptors.menuList}
elementId={descriptors.menuList.setId(elementId)}
ref={containerRef}
ref={mergedRef}
role='menu'
onKeyDown={onKeyDown}
sx={[
Expand Down
74 changes: 67 additions & 7 deletions packages/ui/src/elements/Select.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -46,6 +46,12 @@ type SelectState<O extends Option> = Pick<
select: (option: O) => void;
focusedItemRef: React.RefObject<HTMLDivElement>;
onTriggerClick: () => void;
generatedTriggerId: string;
triggerId: string;
setTriggerId: React.Dispatch<React.SetStateAction<string>>;
generatedListboxId: string;
listboxId: string;
setListboxId: React.Dispatch<React.SetStateAction<string>>;
portal?: boolean;
};

Expand DownExpand Up@@ -97,11 +103,17 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
} = props;
const popoverCtx = usePopover({
autoUpdate: true,
adjustToReferenceWidth: !!referenceElement,
// +2px compensates for the 1px border on each side of the trigger
adjustToReferenceWidth: 2,
referenceElement: referenceElement,
offset: { mainAxis: 6, crossAxis: -1 },
});
const togglePopover = popoverCtx.toggle;
const focusedItemRef = React.useRef<HTMLDivElement>(null);
const generatedTriggerId = React.useId();
const generatedListboxId = React.useId();
const [triggerId, setTriggerId] = React.useState(generatedTriggerId);
const [listboxId, setListboxId] = React.useState(generatedListboxId);
const searchInputCtx = useSearchInput({
items: options,
comparator: comparator || (() => true),
Expand DownExpand Up@@ -139,6 +151,12 @@ export const Select = withFloatingTree(<O extends Option>(props: PropsWithChildr
comparator,
select,
onTriggerClick: togglePopover,
generatedTriggerId,
triggerId,
setTriggerId,
generatedListboxId,
listboxId,
setListboxId,
elementId,
portal,
},
Expand DownExpand Up@@ -167,6 +185,8 @@ const SelectRenderOption = React.memo(
return (
<Flex
ref={ref}
role='option'
aria-selected={isSelected}
sx={{
userSelect: 'none',
cursor: 'pointer',
Expand DownExpand Up@@ -240,7 +260,16 @@ type SelectOptionListProps = PropsOfComponent<typeof Flex> & {
};

export const SelectOptionList = (props: SelectOptionListProps) => {
const { containerSx, sx, footer, onReachEnd, ...rest } = props;
const {
containerSx,
sx,
footer,
onReachEnd,
id,
'aria-label': ariaLabel,
'aria-labelledby': ariaLabelledBy,
...rest
} = props;
const {
popoverCtx,
searchInputCtx,
Expand All@@ -253,12 +282,21 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
select,
onTriggerClick,
elementId,
triggerId,
generatedListboxId,
setListboxId,
portal,
} = useSelectState();
const { filteredItems: options, searchInputProps } = searchInputCtx;
const [focusedIndex, setFocusedIndex] = useState(0);
const { isOpen, floating, styles, nodeId, context } = popoverCtx;
const containerRef = React.useRef<HTMLDivElement>(null);
const effectiveListboxId = id ?? generatedListboxId;
const effectiveAriaLabelledBy = ariaLabelledBy ?? (ariaLabel ? undefined : triggerId);

React.useEffect(() => {
setListboxId(effectiveListboxId);
}, [effectiveListboxId, setListboxId]);

const scrollToItemOnSelectedIndexChange = () => {
if (!isOpen) {
Expand DownExpand Up@@ -338,8 +376,7 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
}),
sx,
]}
// eslint-disable-next-line custom-rules/no-physical-css-properties -- Floating UI library positioning
style={{ ...styles, left: styles.left - 1 }}
style={styles}
>
{comparator && (
<SelectSearchbar
Expand All@@ -349,7 +386,11 @@ export const SelectOptionList = (props: SelectOptionListProps) => {
)}
<Flex
ref={containerRef}
id={effectiveListboxId}
direction='col'
role='listbox'
aria-label={ariaLabel}
aria-labelledby={effectiveAriaLabelledBy}
tabIndex={comparator ? undefined : 0}
sx={[
theme => ({
Expand DownExpand Up@@ -395,9 +436,24 @@ export const SelectButton = (
iconSx?: ThemableCssProp;
},
) => {
const { sx, children, icon, iconSx, ...rest } = props;
const { popoverCtx, onTriggerClick, buttonRenderOption, selectedOption, placeholder, elementId } = useSelectState();
const { reference } = popoverCtx;
const { sx, children, icon, iconSx, id, 'aria-controls': ariaControls, ...rest } = props;
const {
popoverCtx,
onTriggerClick,
buttonRenderOption,
selectedOption,
placeholder,
elementId,
generatedTriggerId,
listboxId,
setTriggerId,
} = useSelectState();
const { reference, isOpen } = popoverCtx;
const effectiveTriggerId = id ?? generatedTriggerId;

React.useEffect(() => {
setTriggerId(effectiveTriggerId);
}, [effectiveTriggerId, setTriggerId]);

let show: React.ReactNode = children;
if (!children) {
Expand All@@ -409,9 +465,13 @@ export const SelectButton = (
elementDescriptor={descriptors.selectButton}
elementId={descriptors.selectButton.setId(elementId)}
ref={reference}
id={effectiveTriggerId}
variant='outline'
textVariant='buttonLarge'
onClick={onTriggerClick}
aria-expanded={isOpen}
aria-haspopup='listbox'
aria-controls={ariaControls ?? (isOpen ? listboxId : undefined)}
sx={[
theme => ({
gap: theme.space.$2,
Expand Down
2 changes: 1 addition & 1 deletion packages/ui/src/elements/ThreeDotsMenu.tsx
Original file line numberDiff line numberDiff line change
Expand Up@@ -33,7 +33,7 @@ export const ThreeDotsMenu = (props: ThreeDotsMenuProps) => {

return (
<Menu elementId={elementId}>
<MenuTrigger arialLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<MenuTrigger ariaLabel={isOpen => `${isOpen ? 'Close' : 'Open'} menu`}>
<Button
sx={t =>
!isBordered
Expand Down
121 changes: 121 additions & 0 deletions packages/ui/src/elements/__tests__/Select.test.tsx
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
import { ClerkInstanceContext } from '@clerk/shared/react';
import { render, screen } from '@testing-library/react';
import userEvent from '@testing-library/user-event';
import type { PropsWithChildren, ReactElement } from 'react';
import { describe, expect, it, vi } from 'vitest';

import { EnvironmentProvider } from '../../contexts';
import { AppearanceProvider } from '../../customizables';
import { InternalThemeProvider } from '../../styledSystem';
import { Select, SelectButton, SelectOptionList } from '../Select';

const options = [
{ value: 'one', label: 'One' },
{ value: 'two', label: 'Two' },
];

const TestProviders = ({ children }: PropsWithChildren) => (
<ClerkInstanceContext.Provider value={{ value: { client: {}, user: {} } as any }}>
<EnvironmentProvider value={{ displayConfig: { applicationName: 'TestApp' } } as any}>
<AppearanceProvider>
<InternalThemeProvider>{children}</InternalThemeProvider>
</AppearanceProvider>
</EnvironmentProvider>
</ClerkInstanceContext.Provider>
);

const renderSelect = (ui: ReactElement) => {
return render(ui, { wrapper: TestProviders });
};

describe('Select', () => {
it('labels the listbox with the generated trigger id by default', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
/>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(button).toHaveAttribute('id');
expect(listbox).toHaveAttribute('id');
expect(listbox).toHaveAttribute('aria-labelledby', button.id);
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('labels the listbox with an explicit trigger id', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton id='expiration-field' />
<SelectOptionList />
</Select>,
);

const button = document.getElementById('expiration-field') as HTMLButtonElement;

await user.click(button);

const listbox = await screen.findByRole('listbox');

expect(listbox).toHaveAttribute('aria-labelledby', 'expiration-field');
expect(button).toHaveAttribute('aria-controls', listbox.id);
});

it('preserves an explicit listbox aria-label', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<SelectButton />
<SelectOptionList aria-label='Expiration options' />
</Select>,
);

await user.click(screen.getByRole('button', { name: 'Select an option' }));

const listbox = await screen.findByRole('listbox', { name: 'Expiration options' });

expect(listbox).toHaveAttribute('aria-label', 'Expiration options');
expect(listbox).not.toHaveAttribute('aria-labelledby');
});

it('preserves an explicit listbox aria-labelledby', async () => {
const user = userEvent.setup();
renderSelect(
<Select
options={options}
value={null}
onChange={vi.fn()}
>
<span id='external-label'>External options</span>
<SelectButton />
<SelectOptionList aria-labelledby='external-label' />
</Select>,
);

const button = screen.getByRole('button', { name: 'Select an option' });

await user.click(button);

const listbox = await screen.findByRole('listbox', { name: 'External options' });

expect(listbox).toHaveAttribute('aria-labelledby', 'external-label');
expect(listbox).not.toHaveAttribute('aria-labelledby', button.id);
});
});
7 changes: 4 additions & 3 deletions packages/ui/src/hooks/usePopover.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -9,7 +9,7 @@ type UsePopoverProps = {
shoudFlip?: boolean;
autoUpdate?: boolean;
outsidePress?: boolean | ((event: MouseEvent) => boolean);
adjustToReferenceWidth?: boolean;
adjustToReferenceWidth?: boolean | number;
referenceElement?: React.RefObject<HTMLElement> | null;
canCloseModal?: boolean;
bubbles?:
Expand DownExpand Up@@ -60,9 +60,10 @@ export const usePopover = (props: UsePopoverProps = {}): UsePopoverReturn => {
shift(),
size({
apply({ elements }) {
if (adjustToReferenceWidth) {
if (typeof adjustToReferenceWidth === 'number' || adjustToReferenceWidth === true) {
const reference = elements.reference as any as HTMLElement;
elements.floating.style.width = reference ? `${reference?.offsetWidth}px` : '';
const extra = typeof adjustToReferenceWidth === 'number' ? adjustToReferenceWidth : 0;
elements.floating.style.width = reference ? `${reference.offsetWidth + extra}px` : '';
}
},
}),
Expand Down
Loading