An open source design system that's fully customizable and agent ready
TypeScript
fix(ComplexSelector): a disabled trigger keeps its tab stop (#7845)
Cindy Zhang1b3f668009d9
diff --git a/.changeset/complexselector-focusable-disabled.md b/.changeset/complexselector-focusable-disabled.mdnew file mode 100644index 0000000000..cb1b4352ca--- /dev/null+++ b/.changeset/complexselector-focusable-disabled.md@@ -0,0 +1,7 @@+---+'@astryxdesign/core': patch+---++[fix] A disabled `ComplexSelector` keeps its place in the tab order, so keyboard and screen-reader users can reach it and hear that it is unavailable (WCAG 2.2 SC 2.1.1 Keyboard and 4.1.2 Name, Role, Value; `spec:AST-085` FR1, FR2 and FR4). Before, its trigger rendered the native `disabled` attribute, so Tab skipped it and a focused trigger lost focus when disabled; now it exposes `aria-disabled="true"`, keeps focus, shows its keyboard focus outline, and still opens nothing. A press or key on it reaches no handler: not the toggle, not a caller's `onClick` or `onKeyDown`, and not an ancestor's click handler.++@cixzhangdiff --git a/packages/core/src/ComplexSelector/ComplexSelector.focusableDisabled.test.tsx b/packages/core/src/ComplexSelector/ComplexSelector.focusableDisabled.test.tsxnew file mode 100644index 0000000000..8ac2ec8171--- /dev/null+++ b/packages/core/src/ComplexSelector/ComplexSelector.focusableDisabled.test.tsx@@ -0,0 +1,76 @@+// Copyright (c) Meta Platforms, Inc. and affiliates.++/**+ * @file ComplexSelector.focusableDisabled.test.tsx+ * @input Uses vitest, @testing-library/react, ComplexSelector+ * @output Conformance tests for spec:AST-085 FR1, FR2 and FR4 on ComplexSelector+ * @position Testing; validates the disabled trigger of ComplexSelector.tsx+ */++import {describe, it, expect, vi} from 'vitest';+import {act, render, screen} from '@testing-library/react';+import userEvent from '@testing-library/user-event';+import {ComplexSelector} from './ComplexSelector';++function Harness(props: {+ isDisabled: boolean;+ onClick?: () => void;+ onKeyDown?: () => void;+}) {+ return (+ <>+ <button type="button">Before</button>+ <ComplexSelector label="View options" value={[]} {...props}>+ {() => <button type="button">Apply</button>}+ </ComplexSelector>+ <button type="button">After</button>+ </>+ );+}++const trigger = () => screen.getByRole('button', {name: 'View options'});++describe('ComplexSelector disabled (spec:AST-085)', () => {+ it('FR1: renders no native disabled and keeps its tab stop', async () => {+ const user = userEvent.setup();+ const {container} = render(<Harness isDisabled />);+ expect(container.querySelector('[disabled]')).toBeNull();+ expect(trigger()).toHaveAttribute('aria-disabled', 'true');+ await user.click(screen.getByRole('button', {name: 'Before'}));+ await user.tab();+ expect(trigger()).toHaveFocus();+ await user.tab();+ expect(screen.getByRole('button', {name: 'After'})).toHaveFocus();+ });++ it('FR2: no press or key opens it or reaches a caller or ancestor handler', async () => {+ const user = userEvent.setup();+ const onClick = vi.fn();+ const onKeyDown = vi.fn();+ const onAncestorClick = vi.fn();+ render(+ <div onClick={onAncestorClick}>+ <Harness isDisabled onClick={onClick} onKeyDown={onKeyDown} />+ </div>,+ );+ await user.click(trigger());+ await user.click(trigger().parentElement!);+ trigger().focus();+ for (const key of ['{Enter}', ' ', '{ArrowDown}']) {+ await user.keyboard(key);+ }+ expect(trigger()).toHaveAttribute('aria-expanded', 'false');+ expect(screen.queryByRole('dialog')).toBeNull();+ expect(onClick).not.toHaveBeenCalled();+ expect(onKeyDown).not.toHaveBeenCalled();+ expect(onAncestorClick).not.toHaveBeenCalled();+ });++ it('FR4: keeps focus when it becomes disabled while focused', () => {+ const {rerender} = render(<Harness isDisabled={false} />);+ act(() => trigger().focus());+ rerender(<Harness isDisabled />);+ expect(trigger()).toHaveFocus();+ expect(trigger()).toHaveAttribute('aria-disabled', 'true');+ });+});diff --git a/packages/core/src/ComplexSelector/ComplexSelector.tsx b/packages/core/src/ComplexSelector/ComplexSelector.tsxindex 1e8907fa16..4337f34ae4 100644--- a/packages/core/src/ComplexSelector/ComplexSelector.tsx+++ b/packages/core/src/ComplexSelector/ComplexSelector.tsx@@ -609,10 +609,24 @@ export function ComplexSelector<Value>({event: React.KeyboardEvent<HTMLElement>,) => {handleTriggerKeyDown(event);- onKeyDownProp?.(event);+ // A disabled trigger keeps its tab stop but invokes no callback+ // (`spec:AST-085` FR2).+ if (!isDisabled) {+ onKeyDownProp?.(event);+ }+ };+ // A press on a disabled control reaches no handler, the component's or an+ // ancestor's, as with a natively disabled button (`spec:AST-085` FR2).+ const swallowDisabledPress = (event: React.MouseEvent<HTMLElement>) => {+ event.preventDefault();+ event.stopPropagation();};const handleControlBoxClick = useCallback((event: React.MouseEvent<HTMLDivElement>) => {+ if (isDisabled) {+ event.stopPropagation();+ return;+ }if (triggerRef.current?.contains(event.target as Node)) {return;}@@ -620,7 +634,7 @@ export function ComplexSelector<Value>({// press on the trigger itself, caller `onClick` included.triggerRef.current?.click();},- [],+ [isDisabled],);useImperativeHandle(@@ -767,8 +781,11 @@ export function ComplexSelector<Value>({aria-required={isEffectivelyRequired ? 'true' : undefined}aria-invalid={status?.type === 'error' ? 'true' : undefined}aria-busy={isBusy || undefined}- disabled={isDisabled}- onClick={handleTriggerButtonClick}+ // A disabled trigger keeps its tab stop and says so through+ // aria-disabled (`spec:AST-085` FR1). Its press runs neither the+ // caller's handler nor the toggle (FR2).+ aria-disabled={isDisabled ? 'true' : undefined}+ onClick={isDisabled ? swallowDisabledPress : handleTriggerButtonClick}onKeyDown={handleTriggerButtonKeyDown}{...stylex.props(styles.trigger)}><span {...stylex.props(styles.triggerText)}>{triggerContent}</span>diff --git a/packages/lab/src/TransferList/TransferListSelector.test.tsx b/packages/lab/src/TransferList/TransferListSelector.test.tsxindex 986329a31d..3889a12fc5 100644--- a/packages/lab/src/TransferList/TransferListSelector.test.tsx+++ b/packages/lab/src/TransferList/TransferListSelector.test.tsx@@ -461,7 +461,9 @@ describe('TransferListSelector', () => {expect(cancel).toBeEnabled();expect(fieldset).not.toContainElement(cancel);expect(apply).toBeDisabled();- expect(screen.getByRole('button', {name: 'Visible fields'})).toBeDisabled();+ expect(+ screen.getByRole('button', {name: 'Visible fields'}),+ ).toHaveAttribute('aria-disabled', 'true');view.rerender(<TransferListSelector