Skip to content

Commit ca36404

Browse files
xyrollehuntabyte
andauthored
fix(Combobox): open the trigger on a click that no pointer press precedes (#2186)
Co-authored-by: Hunter Johnston <[email protected]>
1 parent 9b3a9f2 commit ca36404

4 files changed

Lines changed: 145 additions & 0 deletions

File tree

‎.changeset/quiet-hands-press.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"bits-ui": patch
3+
---
4+
5+
fix(Combobox): open the trigger on a click that no pointer press precedes (`detail: 0`), such as `element.click()` or a VoiceOver activation in Safari

‎packages/bits-ui/src/lib/bits/select/select.svelte.ts‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -727,6 +727,7 @@ export class SelectComboTriggerState {
727727
this.onkeydown = this.onkeydown.bind(this);
728728
this.onpointerdown = this.onpointerdown.bind(this);
729729
this.onpointerup = this.onpointerup.bind(this);
730+
this.onclick = this.onclick.bind(this);
730731
}
731732

732733
#focusInputAndToggle() {
@@ -774,6 +775,17 @@ export class SelectComboTriggerState {
774775
this.#focusInputAndToggle();
775776
}
776777

778+
/**
779+
* Screen readers can activate the trigger with a `click` that no pointer events
780+
* precede (VoiceOver in Safari). A click that ends a press has a non-zero `detail`
781+
* and was already handled by `onpointerdown` / `onpointerup`.
782+
*/
783+
onclick(e: BitsMouseEvent) {
784+
if (this.root.opts.disabled.current || e.detail !== 0) return;
785+
this.#focusInputAndToggle();
786+
e.preventDefault();
787+
}
788+
777789
readonly props = $derived.by(
778790
() =>
779791
({
@@ -785,6 +797,7 @@ export class SelectComboTriggerState {
785797
[this.root.getBitsAttr("trigger")]: "",
786798
onpointerdown: this.onpointerdown,
787799
onpointerup: this.onpointerup,
800+
onclick: this.onclick,
788801
onkeydown: this.onkeydown,
789802
...this.attachment,
790803
}) as const
Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
<script lang="ts" module>
2+
import { Combobox, type ComboboxSingleRootProps, type WithoutChildren } from "bits-ui";
3+
4+
export type ComboboxTriggerInputTestProps = Omit<
5+
WithoutChildren<ComboboxSingleRootProps>,
6+
"type"
7+
>;
8+
</script>
9+
10+
<script lang="ts">
11+
let { open = false, ...restProps }: ComboboxTriggerInputTestProps = $props();
12+
</script>
13+
14+
<main>
15+
<Combobox.Root type="single" bind:open {...restProps}>
16+
<Combobox.Trigger>
17+
{#snippet child({ props })}
18+
<div {...props} data-testid="trigger">
19+
<label for="trigger-input" data-testid="label">Fruit</label>
20+
<Combobox.Input id="trigger-input" data-testid="input" />
21+
</div>
22+
{/snippet}
23+
</Combobox.Trigger>
24+
<Combobox.Portal>
25+
<Combobox.Content data-testid="content">
26+
<Combobox.Item value="1" label="A">A</Combobox.Item>
27+
<Combobox.Item value="2" label="B">B</Combobox.Item>
28+
</Combobox.Content>
29+
</Combobox.Portal>
30+
</Combobox.Root>
31+
<button data-testid="outside">outside</button>
32+
</main>

‎tests/src/tests/combobox/combobox.browser.test.ts‎

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ import ComboboxTest from "./combobox-test.svelte";
77
import type { ComboboxSingleTestProps, Item } from "./combobox-test.svelte";
88
import type { ComboboxMultipleTestProps } from "./combobox-multi-test.svelte";
99
import ComboboxMultiTest from "./combobox-multi-test.svelte";
10+
import ComboboxTriggerInputTest from "./combobox-trigger-input-test.svelte";
1011
import ComboboxForceMountTest, {
1112
type ComboboxForceMountTestProps,
1213
} from "./combobox-force-mount-test.svelte";
@@ -993,6 +994,100 @@ describe("Touch", () => {
993994
});
994995
});
995996

997+
describe("Activation without a pointer press", () => {
998+
it("should toggle the trigger on a click that no pointer press preceded", async () => {
999+
const t = setupSingle();
1000+
(t.trigger.element() as HTMLElement).click();
1001+
await expectExists(t.getContent());
1002+
await expect.element(t.openBinding).toHaveTextContent("true");
1003+
await expect.element(t.input).toHaveFocus();
1004+
(t.trigger.element() as HTMLElement).click();
1005+
await expectNotExists(t.getContent());
1006+
await expect.element(t.openBinding).toHaveTextContent("false");
1007+
});
1008+
1009+
it("should open on the event sequence of a WebKit accessibility press", async () => {
1010+
const t = setupSingle();
1011+
const trigger = t.trigger.element() as HTMLElement;
1012+
// focus, mousedown, mouseup and a zero-`detail` click, with no pointer events
1013+
trigger.focus();
1014+
for (const type of ["mousedown", "mouseup", "click"]) {
1015+
trigger.dispatchEvent(
1016+
new MouseEvent(type, { bubbles: true, cancelable: true, detail: 0 })
1017+
);
1018+
}
1019+
await expectExists(t.getContent());
1020+
await expect.element(t.openBinding).toHaveTextContent("true");
1021+
});
1022+
1023+
it("should not toggle again on the click that ends a tap", async () => {
1024+
const onOpenChange = vi.fn();
1025+
const t = setupSingle({ onOpenChange });
1026+
const trigger = t.trigger.element();
1027+
for (const type of ["pointerdown", "pointerup"] as const) {
1028+
trigger.dispatchEvent(
1029+
new PointerEvent(type, {
1030+
bubbles: true,
1031+
cancelable: true,
1032+
pointerType: "touch",
1033+
isPrimary: true,
1034+
button: 0,
1035+
buttons: type === "pointerdown" ? 1 : 0,
1036+
})
1037+
);
1038+
}
1039+
// a touch click can arrive in a later task than the `pointerup` (Chromium on Android)
1040+
await new Promise((resolve) => setTimeout(resolve));
1041+
trigger.dispatchEvent(
1042+
new MouseEvent("click", { bubbles: true, cancelable: true, detail: 1 })
1043+
);
1044+
await expectExists(t.getContent());
1045+
expect(onOpenChange).toHaveBeenCalledTimes(1);
1046+
});
1047+
1048+
it("should not toggle again on the click that ends a mouse press", async () => {
1049+
const onOpenChange = vi.fn();
1050+
const t = setupSingle({ onOpenChange });
1051+
await t.trigger.click();
1052+
await expectExists(t.getContent());
1053+
expect(onOpenChange).toHaveBeenCalledTimes(1);
1054+
});
1055+
1056+
it.each([kbd.ENTER, kbd.SPACE])(
1057+
"should toggle once when %s is pressed on the trigger",
1058+
async (key) => {
1059+
const onOpenChange = vi.fn();
1060+
const t = setupSingle({ onOpenChange });
1061+
(t.trigger.element() as HTMLElement).focus();
1062+
await t.user.keyboard(key);
1063+
await expectExists(t.getContent());
1064+
expect(onOpenChange).toHaveBeenCalledTimes(1);
1065+
}
1066+
);
1067+
1068+
it("should toggle once when a label inside the trigger is clicked without a pointer press", async () => {
1069+
const onOpenChange = vi.fn();
1070+
render(ComboboxTriggerInputTest, { onOpenChange });
1071+
// the label would forward a second zero-`detail` click to its input
1072+
(page.getByTestId("label").element() as HTMLElement).click();
1073+
await expectExists(page.getByTestId("content"));
1074+
expect(onOpenChange).toHaveBeenCalledTimes(1);
1075+
});
1076+
1077+
it("should not toggle on a click without a pointer press when disabled", async () => {
1078+
const onOpenChange = vi.fn();
1079+
// a `div` trigger, which unlike a disabled `<button>` still receives the click
1080+
render(ComboboxTriggerInputTest, { onOpenChange, disabled: true });
1081+
const outside = page.getByTestId("outside").element() as HTMLElement;
1082+
outside.focus();
1083+
(page.getByTestId("trigger").element() as HTMLElement).click();
1084+
await tick();
1085+
await expectNotExists(page.getByTestId("content"));
1086+
expect(onOpenChange).not.toHaveBeenCalled();
1087+
expect(document.activeElement).toBe(outside);
1088+
});
1089+
});
1090+
9961091
it("should not open when the trigger is disabled by an ancestor `fieldset`", async () => {
9971092
render(ComboboxFieldsetDisabledTest);
9981093
const trigger = page.getByTestId("trigger");

0 commit comments

Comments
 (0)