Skip to content

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

TypeScript

fix(selector): make combobox trigger keyboard-focusable (#3324)

Cindy Zhangddc5ef8f1222
diff --git a/.changeset/selector-keyboard-focusable.md b/.changeset/selector-keyboard-focusable.md
new file mode 100644
index 0000000000..74078869b8
--- /dev/null
+++ b/.changeset/selector-keyboard-focusable.md
@@ -0,0 +1,6 @@
+---
+'@astryxdesign/core': patch
+---
+
+[fix] Selector, MultiSelector: the combobox trigger is now keyboard-focusable (`tabIndex=0` when enabled). Previously it was `tabIndex=-1`, so keyboard and screen-reader users could not open or operate the control in the default (non-search) mode. The Clear button is now keyboard-reachable too (#3320)
+@cixzhang
diff --git a/packages/core/src/MultiSelector/MultiSelector.test.tsx b/packages/core/src/MultiSelector/MultiSelector.test.tsx
index 65ca607d56..121da3a4f6 100644
--- a/packages/core/src/MultiSelector/MultiSelector.test.tsx
+++ b/packages/core/src/MultiSelector/MultiSelector.test.tsx
@@ -675,4 +675,64 @@ describe('MultiSelector', () => {
it('has displayName', () => {
expect(MultiSelector.displayName).toBe('MultiSelector');
});
+
+ describe('keyboard accessibility', () => {
+ it('trigger is focusable via Tab when enabled', async () => {
+ const user = userEvent.setup();
+ render(
+ <MultiSelector
+ label="Fruit"
+ options={defaultOptions}
+ value={[]}
+ onChange={() => {}}
+ />,
+ );
+ await user.tab();
+ expect(screen.getByRole('combobox')).toHaveFocus();
+ });
+
+ it('trigger is not focusable when disabled', () => {
+ render(
+ <MultiSelector
+ label="Fruit"
+ options={defaultOptions}
+ value={[]}
+ onChange={() => {}}
+ isDisabled
+ />,
+ );
+ expect(screen.getByRole('combobox')).toHaveAttribute('tabIndex', '-1');
+ });
+
+ it('opens the listbox with ArrowDown from a focused trigger', async () => {
+ const user = userEvent.setup();
+ render(
+ <MultiSelector
+ label="Fruit"
+ options={defaultOptions}
+ value={[]}
+ onChange={() => {}}
+ />,
+ );
+ const trigger = screen.getByRole('combobox');
+ await user.tab();
+ expect(trigger).toHaveFocus();
+ await user.keyboard('{ArrowDown}');
+ expect(trigger).toHaveAttribute('aria-expanded', 'true');
+ });
+
+ it('clear button is reachable by keyboard', () => {
+ render(
+ <MultiSelector
+ label="Fruit"
+ options={defaultOptions}
+ value={['Apple', 'Banana']}
+ onChange={() => {}}
+ hasClear
+ />,
+ );
+ const clear = screen.getByRole('button', {name: 'Clear all Fruit'});
+ expect(clear).not.toHaveAttribute('tabIndex', '-1');
+ });
+ });
});
diff --git a/packages/core/src/MultiSelector/MultiSelector.tsx b/packages/core/src/MultiSelector/MultiSelector.tsx
index 6b84054197..6d7ab122ef 100644
--- a/packages/core/src/MultiSelector/MultiSelector.tsx
+++ b/packages/core/src/MultiSelector/MultiSelector.tsx
@@ -1159,7 +1159,7 @@ export function MultiSelector<T extends MultiSelectorOptionType>({
aria-busy={isBusy || undefined}
disabled={isDisabled}
onKeyDown={onKeyDown}
- tabIndex={-1}
+ tabIndex={isDisabled ? -1 : 0}
{...stylex.props(styles.trigger)}>
<span {...stylex.props(styles.triggerContent)}>
{renderTriggerContent()}
@@ -1169,7 +1169,6 @@ export function MultiSelector<T extends MultiSelectorOptionType>({
{hasClear && value.length > 0 && !isDisabled && (
<button
type="button"
- tabIndex={-1}
onClick={handleClear}
aria-label={`Clear all ${label}`}
{...stylex.props(styles.clearButton)}>
diff --git a/packages/core/src/Selector/Selector.test.tsx b/packages/core/src/Selector/Selector.test.tsx
index bf2ad773ce..7fbdd0b1e3 100644
--- a/packages/core/src/Selector/Selector.test.tsx
+++ b/packages/core/src/Selector/Selector.test.tsx
@@ -467,4 +467,60 @@ describe('Selector', () => {
).toBeInTheDocument();
});
});
+
+ describe('keyboard accessibility', () => {
+ it('trigger is focusable via Tab when enabled', async () => {
+ const user = userEvent.setup();
+ render(<Selector label="Fruit" options={OPTIONS} />);
+
+ await user.tab();
+ expect(screen.getByRole('combobox')).toHaveFocus();
+ });
+
+ it('trigger is not focusable when disabled', () => {
+ render(<Selector label="Fruit" options={OPTIONS} isDisabled />);
+ expect(screen.getByRole('combobox')).toHaveAttribute('tabIndex', '-1');
+ });
+
+ it('opens the listbox with ArrowDown from a focused trigger', async () => {
+ const user = userEvent.setup();
+ render(<Selector label="Fruit" options={OPTIONS} />);
+
+ const trigger = screen.getByRole('combobox');
+ await user.tab();
+ expect(trigger).toHaveFocus();
+
+ await user.keyboard('{ArrowDown}');
+ expect(trigger).toHaveAttribute('aria-expanded', 'true');
+ });
+
+ it('opens and selects an option with Enter (no mouse)', async () => {
+ const user = userEvent.setup();
+ const onChange = vi.fn();
+ render(
+ <Selector label="Fruit" options={OPTIONS} onChange={onChange} />,
+ );
+
+ await user.tab();
+ await user.keyboard('{Enter}'); // open
+ await user.keyboard('{ArrowDown}'); // move highlight
+ await user.keyboard('{Enter}'); // select
+
+ expect(onChange).toHaveBeenCalled();
+ });
+
+ it('clear button is reachable by keyboard', () => {
+ render(
+ <Selector
+ label="Fruit"
+ options={OPTIONS}
+ value="Apple"
+ onChange={() => {}}
+ hasClear
+ />,
+ );
+ const clear = screen.getByRole('button', {name: 'Clear Fruit'});
+ expect(clear).not.toHaveAttribute('tabIndex', '-1');
+ });
+ });
});
diff --git a/packages/core/src/Selector/Selector.tsx b/packages/core/src/Selector/Selector.tsx
index e97973e41b..a7b22e962c 100644
--- a/packages/core/src/Selector/Selector.tsx
+++ b/packages/core/src/Selector/Selector.tsx
@@ -908,7 +908,7 @@ export function Selector<T extends SelectorOptionType>(
aria-busy={isBusy || undefined}
disabled={isDisabled}
onKeyDown={onKeyDown}
- tabIndex={-1}
+ tabIndex={isDisabled ? -1 : 0}
{...stylex.props(styles.trigger)}>
<span {...stylex.props(styles.triggerLabel)}>
{selectedItem?.label ?? placeholder}
@@ -918,7 +918,6 @@ export function Selector<T extends SelectorOptionType>(
{hasClear && value != null && !isDisabled && (
<button
type="button"
- tabIndex={-1}
onClick={handleClear}
aria-label={`Clear ${label}`}
{...stylex.props(styles.clearButton)}>