Skip to content

[combobox] Ensure popup closes when tabbing out of popover #3087

New issue

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

Sign up for GitHub

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

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from
+157 −32
Draft

[combobox] Ensure popup closes when tabbing out of popover #3087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion packages/react/src/combobox/popup/ComboboxPopup.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ export const ComboboxPopup = React.forwardRef(function ComboboxPopup(
const mounted = useStore(store, selectors.mounted);
const open = useStore(store, selectors.open);
const openMethod = useStore(store, selectors.openMethod);
const modal = useStore(store, selectors.modal);
const transitionStatus = useStore(store, selectors.transitionStatus);
const inputInsidePopup = useStore(store, selectors.inputInsidePopup);
const inputElement = useStore(store, selectors.inputElement);
Expand Down Expand Up @@ -114,7 +115,7 @@ export const ComboboxPopup = React.forwardRef(function ComboboxPopup(
<FloatingFocusManager
context={floatingRootContext}
disabled={!mounted}
modal={!inputInsidePopup}
modal={inputInsidePopup ? modal : false}
openInteractionType={openMethod}
initialFocus={resolvedInitialFocus}
returnFocus={resolvedFinalFocus}
Expand Down
186 changes: 155 additions & 31 deletions packages/react/src/combobox/root/ComboboxRoot.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ import { createRenderer, isJSDOM, popupConformanceTests } from '#test-utils';
import { expect } from 'chai';
import { spy } from 'sinon';
import { Combobox } from '@base-ui-components/react/combobox';
import { Popover } from '@base-ui-components/react/popover';
import { Dialog } from '@base-ui-components/react/dialog';
import { Field } from '@base-ui-components/react/field';
import { Form } from '@base-ui-components/react/form';
Expand Down Expand Up @@ -38,41 +39,164 @@ describe('<Combobox.Root />', () => {
combobox: true,
});

it('does not focus input when closing via trigger click (input inside popup)', async () => {
const { user } = await render(
<Combobox.Root items={['One', 'Two', 'Three']}>
<Combobox.Trigger data-testid="trigger">
<Combobox.Value />
</Combobox.Trigger>
<Combobox.Portal>
<Combobox.Positioner>
<Combobox.Popup aria-label="Demo">
<Combobox.Input data-testid="input" />
<Combobox.List>
{(item: string) => (
<Combobox.Item key={item} value={item}>
{item}
</Combobox.Item>
)}
</Combobox.List>
</Combobox.Popup>
</Combobox.Positioner>
</Combobox.Portal>
</Combobox.Root>,
);
describe('focus management', () => {
it('does not focus input when closing via trigger click (input inside popup)', async () => {
const { user } = await render(
<Combobox.Root items={['One', 'Two', 'Three']}>
<Combobox.Trigger data-testid="trigger">
<Combobox.Value />
</Combobox.Trigger>
<Combobox.Portal>
<Combobox.Positioner>
<Combobox.Popup aria-label="Demo">
<Combobox.Input data-testid="input" />
<Combobox.List>
{(item: string) => (
<Combobox.Item key={item} value={item}>
{item}
</Combobox.Item>
)}
</Combobox.List>
</Combobox.Popup>
</Combobox.Positioner>
</Combobox.Portal>
</Combobox.Root>,
);

const trigger = screen.getByTestId('trigger');
await user.click(trigger);
const trigger = screen.getByTestId('trigger');
await user.click(trigger);

expect(await screen.findByRole('listbox')).not.to.equal(null);
expect(await screen.findByRole('listbox')).not.to.equal(null);

const input = await waitFor(() =>
screen.getAllByRole('combobox').find((element) => element.tagName === 'INPUT'),
);
expect(input).toHaveFocus();
const input = await waitFor(() =>
screen.getAllByRole('combobox').find((element) => element.tagName === 'INPUT'),
);
expect(input).toHaveFocus();

await user.click(trigger);
expect(trigger).toHaveFocus();
});

it('applies aria-hidden to outside nodes when the input renders outside the popup', async () => {
await render(
<div>
<button data-testid="before">before</button>
<Combobox.Root defaultOpen>
<Combobox.Input />
<Combobox.Portal>
<Combobox.Positioner>
<Combobox.Popup>
<Combobox.List>
<Combobox.Item value="apple">Apple</Combobox.Item>
</Combobox.List>
</Combobox.Popup>
</Combobox.Positioner>
</Combobox.Portal>
</Combobox.Root>
<button data-testid="after">after</button>
</div>,
);

await waitFor(() => {
expect(screen.getByTestId('before').closest('[aria-hidden="true"]')).not.to.equal(null);
expect(screen.getByTestId('after').closest('[aria-hidden="true"]')).not.to.equal(null);
});
expect(screen.getByRole('listbox')).not.to.have.attribute('aria-hidden');
});

it('does not apply aria-hidden to outside nodes when the input renders inside the popup', async () => {
await render(
<div>
<button data-testid="before">before</button>
<Combobox.Root defaultOpen>
<Combobox.Trigger>Toggle</Combobox.Trigger>
<Combobox.Portal>
<Combobox.Positioner>
<Combobox.Popup>
<Combobox.Input />
<Combobox.List>
<Combobox.Item value="apple">Apple</Combobox.Item>
</Combobox.List>
</Combobox.Popup>
</Combobox.Positioner>
</Combobox.Portal>
</Combobox.Root>
<button data-testid="after">after</button>
</div>,
);

expect(screen.getByTestId('before')).not.to.have.attribute('aria-hidden', 'true');
expect(screen.getByTestId('after')).not.to.have.attribute('aria-hidden', 'true');
expect(screen.getByRole('listbox')).not.to.have.attribute('aria-hidden');
});

await user.click(trigger);
expect(trigger).toHaveFocus();
it('applies aria-hidden to outside nodes when the input renders inside the popup and is modal', async () => {
await render(
<div>
<button data-testid="before">before</button>
<Combobox.Root modal defaultOpen>
<Combobox.Trigger>Toggle</Combobox.Trigger>
<Combobox.Portal>
<Combobox.Positioner>
<Combobox.Popup>
<Combobox.Input />
<Combobox.List>
<Combobox.Item value="apple">Apple</Combobox.Item>
</Combobox.List>
</Combobox.Popup>
</Combobox.Positioner>
</Combobox.Portal>
</Combobox.Root>
<button data-testid="after">after</button>
</div>,
);

expect(screen.getByTestId('before').closest('[aria-hidden="true"]')).not.to.equal(null);
expect(screen.getByTestId('after').closest('[aria-hidden="true"]')).not.to.equal(null);
expect(screen.getByRole('listbox')).not.to.have.attribute('aria-hidden');
});

it('closes when tabbing forward from the last tabbable element inside a popover', async () => {
const { user } = await render(
<React.Fragment>
<Popover.Root defaultOpen>
<Popover.Trigger>Toggle</Popover.Trigger>
<Popover.Portal>
<Popover.Positioner>
<Popover.Popup>
<Combobox.Root defaultOpen>
<Combobox.Input />
<Combobox.Portal>
<Combobox.Positioner>
<Combobox.Popup data-testid="combobox-popup">
<Combobox.List>
<Combobox.Item value="apple">Apple</Combobox.Item>
</Combobox.List>
</Combobox.Popup>
</Combobox.Positioner>
</Combobox.Portal>
</Combobox.Root>
</Popover.Popup>
</Popover.Positioner>
</Popover.Portal>
</Popover.Root>
<button data-testid="after" />
</React.Fragment>,
);

await flushMicrotasks();

const input = screen.getByRole('combobox');
expect(screen.queryByTestId('combobox-popup')).not.to.equal(null);

await user.click(input);
await user.tab();

await waitFor(() => {
expect(screen.queryByTestId('combobox-popup')).to.equal(null);
});
expect(screen.getByTestId('after')).toHaveFocus();
});
});

describe('selection behavior', () => {
Expand Down
Loading