@react-aria/test-utils 1.0.0-alpha.3 → 1.0.0-alpha.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (67) hide show
  1. package/dist/combobox.main.js +116 -82
  2. package/dist/combobox.main.js.map +1 -1
  3. package/dist/combobox.mjs +117 -83
  4. package/dist/combobox.module.js +117 -83
  5. package/dist/combobox.module.js.map +1 -1
  6. package/dist/events.main.js +42 -4
  7. package/dist/events.main.js.map +1 -1
  8. package/dist/events.mjs +42 -4
  9. package/dist/events.module.js +42 -4
  10. package/dist/events.module.js.map +1 -1
  11. package/dist/gridlist.main.js +102 -59
  12. package/dist/gridlist.main.js.map +1 -1
  13. package/dist/gridlist.mjs +103 -60
  14. package/dist/gridlist.module.js +103 -60
  15. package/dist/gridlist.module.js.map +1 -1
  16. package/dist/listbox.main.js +135 -0
  17. package/dist/listbox.main.js.map +1 -0
  18. package/dist/listbox.mjs +130 -0
  19. package/dist/listbox.module.js +130 -0
  20. package/dist/listbox.module.js.map +1 -0
  21. package/dist/main.js.map +1 -1
  22. package/dist/menu.main.js +195 -161
  23. package/dist/menu.main.js.map +1 -1
  24. package/dist/menu.mjs +196 -162
  25. package/dist/menu.module.js +196 -162
  26. package/dist/menu.module.js.map +1 -1
  27. package/dist/module.js.map +1 -1
  28. package/dist/select.main.js +116 -70
  29. package/dist/select.main.js.map +1 -1
  30. package/dist/select.mjs +117 -71
  31. package/dist/select.module.js +117 -71
  32. package/dist/select.module.js.map +1 -1
  33. package/dist/table.main.js +166 -139
  34. package/dist/table.main.js.map +1 -1
  35. package/dist/table.mjs +167 -140
  36. package/dist/table.module.js +167 -140
  37. package/dist/table.module.js.map +1 -1
  38. package/dist/tabs.main.js +133 -0
  39. package/dist/tabs.main.js.map +1 -0
  40. package/dist/tabs.mjs +128 -0
  41. package/dist/tabs.module.js +128 -0
  42. package/dist/tabs.module.js.map +1 -0
  43. package/dist/tree.main.js +165 -0
  44. package/dist/tree.main.js.map +1 -0
  45. package/dist/tree.mjs +160 -0
  46. package/dist/tree.module.js +160 -0
  47. package/dist/tree.module.js.map +1 -0
  48. package/dist/types.d.ts +607 -145
  49. package/dist/types.d.ts.map +1 -1
  50. package/dist/user.main.js +15 -4
  51. package/dist/user.main.js.map +1 -1
  52. package/dist/user.mjs +15 -4
  53. package/dist/user.module.js +15 -4
  54. package/dist/user.module.js.map +1 -1
  55. package/package.json +3 -4
  56. package/src/combobox.ts +105 -36
  57. package/src/events.ts +29 -4
  58. package/src/gridlist.ts +146 -59
  59. package/src/index.ts +1 -1
  60. package/src/listbox.ts +226 -0
  61. package/src/menu.ts +152 -62
  62. package/src/select.ts +137 -44
  63. package/src/table.ts +130 -69
  64. package/src/tabs.ts +198 -0
  65. package/src/tree.ts +248 -0
  66. package/src/types.ts +133 -0
  67. package/src/user.ts +62 -37
@@ -18,99 +18,133 @@ $parcel$export(module.exports, "ComboBoxTester", () => $15e4b71f2b6c4964$export$
18
18
  * governing permissions and limitations under the License.
19
19
  */
20
20
  class $15e4b71f2b6c4964$export$f97e14e96d71ab3b {
21
- get combobox() {
21
+ /**
22
+ * Set the interaction type used by the combobox tester.
23
+ */ setInteractionType(type) {
24
+ this._interactionType = type;
25
+ }
26
+ /**
27
+ * Opens the combobox dropdown. Defaults to using the interaction type set on the combobox tester.
28
+ */ async open(opts = {}) {
29
+ let { triggerBehavior: triggerBehavior = 'manual', interactionType: interactionType = this._interactionType } = opts;
30
+ let trigger = this.trigger;
31
+ let combobox = this.combobox;
32
+ let isDisabled = trigger.hasAttribute('disabled');
33
+ if (interactionType === 'mouse') {
34
+ if (triggerBehavior === 'focus') await this.user.click(combobox);
35
+ else await this.user.click(trigger);
36
+ } else if (interactionType === 'keyboard' && this._trigger != null) {
37
+ (0, $f8PS3$testinglibraryreact.act)(()=>this._trigger.focus());
38
+ if (triggerBehavior !== 'focus') await this.user.keyboard('{ArrowDown}');
39
+ } else if (interactionType === 'touch') {
40
+ if (triggerBehavior === 'focus') await this.user.pointer({
41
+ target: combobox,
42
+ keys: '[TouchA]'
43
+ });
44
+ else await this.user.pointer({
45
+ target: trigger,
46
+ keys: '[TouchA]'
47
+ });
48
+ }
49
+ await (0, $f8PS3$testinglibraryreact.waitFor)(()=>{
50
+ if (!isDisabled && combobox.getAttribute('aria-controls') == null) throw new Error('No aria-controls found on combobox trigger element.');
51
+ else return true;
52
+ });
53
+ let listBoxId = combobox.getAttribute('aria-controls');
54
+ await (0, $f8PS3$testinglibraryreact.waitFor)(()=>{
55
+ if (!isDisabled && (!listBoxId || document.getElementById(listBoxId) == null)) throw new Error(`Listbox with id of ${listBoxId} not found in document.`);
56
+ else return true;
57
+ });
58
+ }
59
+ /**
60
+ * Returns an option matching the specified index or text content.
61
+ */ findOption(opts) {
62
+ let { optionIndexOrText: optionIndexOrText } = opts;
63
+ let option;
64
+ let options = this.options();
65
+ let listbox = this.listbox;
66
+ if (typeof optionIndexOrText === 'number') option = options[optionIndexOrText];
67
+ else if (typeof optionIndexOrText === 'string' && listbox != null) option = (0, $f8PS3$testinglibraryreact.within)(listbox).getByText(optionIndexOrText).closest('[role=option]');
68
+ return option;
69
+ }
70
+ /**
71
+ * Selects the desired combobox option. Defaults to using the interaction type set on the combobox tester. If necessary, will open the combobox dropdown beforehand.
72
+ * The desired option can be targeted via the option's node, the option's text, or the option's index.
73
+ */ async selectOption(opts) {
74
+ let { option: option, triggerBehavior: triggerBehavior, interactionType: interactionType = this._interactionType } = opts;
75
+ if (!this.combobox.getAttribute('aria-controls')) await this.open({
76
+ triggerBehavior: triggerBehavior
77
+ });
78
+ let listbox = this.listbox;
79
+ if (!listbox) throw new Error('Combobox\'s listbox not found.');
80
+ if (listbox) {
81
+ if (typeof option === 'string' || typeof option === 'number') option = this.findOption({
82
+ optionIndexOrText: option
83
+ });
84
+ if (!option) throw new Error('Target option not found in the listbox.');
85
+ // TODO: keyboard method of selecting the the option is a bit tricky unless I simply simulate the user pressing the down arrow
86
+ // the required amount of times to reach the option. For now just click the option even in keyboard mode
87
+ if (interactionType === 'mouse' || interactionType === 'keyboard') await this.user.click(option);
88
+ else await this.user.pointer({
89
+ target: option,
90
+ keys: '[TouchA]'
91
+ });
92
+ if (option.getAttribute('href') == null) await (0, $f8PS3$testinglibraryreact.waitFor)(()=>{
93
+ if (document.contains(listbox)) throw new Error('Expected listbox element to not be in the document after selecting an option');
94
+ else return true;
95
+ });
96
+ } else throw new Error("Attempted to select a option in the combobox, but the listbox wasn't found.");
97
+ }
98
+ /**
99
+ * Closes the combobox dropdown.
100
+ */ async close() {
101
+ let listbox = this.listbox;
102
+ if (listbox) {
103
+ (0, $f8PS3$testinglibraryreact.act)(()=>this.combobox.focus());
104
+ await this.user.keyboard('[Escape]');
105
+ await (0, $f8PS3$testinglibraryreact.waitFor)(()=>{
106
+ if (document.contains(listbox)) throw new Error('Expected listbox element to not be in the document after selecting an option');
107
+ else return true;
108
+ });
109
+ }
110
+ }
111
+ /**
112
+ * Returns the combobox.
113
+ */ get combobox() {
22
114
  return this._combobox;
23
115
  }
24
- get trigger() {
116
+ /**
117
+ * Returns the combobox trigger button.
118
+ */ get trigger() {
25
119
  return this._trigger;
26
120
  }
27
- get listbox() {
121
+ /**
122
+ * Returns the combobox's listbox if present.
123
+ */ get listbox() {
28
124
  let listBoxId = this.combobox.getAttribute('aria-controls');
29
- return listBoxId ? document.getElementById(listBoxId) || undefined : undefined;
125
+ return listBoxId ? document.getElementById(listBoxId) || null : null;
30
126
  }
31
- get sections() {
127
+ /**
128
+ * Returns the combobox's sections if present.
129
+ */ get sections() {
32
130
  let listbox = this.listbox;
33
- if (listbox) return (0, $f8PS3$testinglibraryreact.within)(listbox).queryAllByRole('group');
34
- else return [];
131
+ return listbox ? (0, $f8PS3$testinglibraryreact.within)(listbox).queryAllByRole('group') : [];
132
+ }
133
+ /**
134
+ * Returns the combobox's options if present. Can be filtered to a subsection of the listbox if provided via `element`.
135
+ */ options(opts = {}) {
136
+ let { element: element = this.listbox } = opts;
137
+ let options = [];
138
+ if (element) options = (0, $f8PS3$testinglibraryreact.within)(element).queryAllByRole('option');
139
+ return options;
35
140
  }
36
- get focusedOption() {
141
+ /**
142
+ * Returns the currently focused option in the combobox's dropdown if any.
143
+ */ get focusedOption() {
37
144
  let focusedOptionId = this.combobox.getAttribute('aria-activedescendant');
38
- return focusedOptionId ? document.getElementById(focusedOptionId) : undefined;
145
+ return focusedOptionId ? document.getElementById(focusedOptionId) : null;
39
146
  }
40
147
  constructor(opts){
41
- this.setInteractionType = (type)=>{
42
- this._interactionType = type;
43
- };
44
- this.open = async (opts = {})=>{
45
- let { triggerBehavior: triggerBehavior = 'manual', interactionType: interactionType = this._interactionType } = opts;
46
- let trigger = this.trigger;
47
- let combobox = this.combobox;
48
- let isDisabled = trigger.hasAttribute('disabled');
49
- if (interactionType === 'mouse') {
50
- if (triggerBehavior === 'focus') await this.user.click(combobox);
51
- else await this.user.click(trigger);
52
- } else if (interactionType === 'keyboard' && this._trigger != null) {
53
- (0, $f8PS3$testinglibraryreact.act)(()=>this._trigger.focus());
54
- if (triggerBehavior !== 'focus') await this.user.keyboard('{ArrowDown}');
55
- } else if (interactionType === 'touch') {
56
- if (triggerBehavior === 'focus') await this.user.pointer({
57
- target: combobox,
58
- keys: '[TouchA]'
59
- });
60
- else await this.user.pointer({
61
- target: trigger,
62
- keys: '[TouchA]'
63
- });
64
- }
65
- await (0, $f8PS3$testinglibraryreact.waitFor)(()=>{
66
- if (!isDisabled && combobox.getAttribute('aria-controls') == null) throw new Error('No aria-controls found on combobox trigger element.');
67
- else return true;
68
- });
69
- let listBoxId = combobox.getAttribute('aria-controls');
70
- await (0, $f8PS3$testinglibraryreact.waitFor)(()=>{
71
- if (!isDisabled && (!listBoxId || document.getElementById(listBoxId) == null)) throw new Error(`Listbox with id of ${listBoxId} not found in document.`);
72
- else return true;
73
- });
74
- };
75
- this.selectOption = async (opts = {})=>{
76
- let { optionText: optionText, option: option, triggerBehavior: triggerBehavior, interactionType: interactionType = this._interactionType } = opts;
77
- if (!this.combobox.getAttribute('aria-controls')) await this.open({
78
- triggerBehavior: triggerBehavior
79
- });
80
- let listbox = this.listbox;
81
- if (listbox) {
82
- if (!option && optionText) option = (0, $f8PS3$testinglibraryreact.within)(listbox).getByText(optionText);
83
- // TODO: keyboard method of selecting the the option is a bit tricky unless I simply simulate the user pressing the down arrow
84
- // the required amount of times to reach the option. For now just click the option even in keyboard mode
85
- if (interactionType === 'mouse' || interactionType === 'keyboard') await this.user.click(option);
86
- else await this.user.pointer({
87
- target: option,
88
- keys: '[TouchA]'
89
- });
90
- if (option && option.getAttribute('href') == null) await (0, $f8PS3$testinglibraryreact.waitFor)(()=>{
91
- if (document.contains(listbox)) throw new Error('Expected listbox element to not be in the document after selecting an option');
92
- else return true;
93
- });
94
- } else throw new Error("Attempted to select a option in the combobox, but the listbox wasn't found.");
95
- };
96
- this.close = async ()=>{
97
- let listbox = this.listbox;
98
- if (listbox) {
99
- (0, $f8PS3$testinglibraryreact.act)(()=>this.combobox.focus());
100
- await this.user.keyboard('[Escape]');
101
- await (0, $f8PS3$testinglibraryreact.waitFor)(()=>{
102
- if (document.contains(listbox)) throw new Error('Expected listbox element to not be in the document after selecting an option');
103
- else return true;
104
- });
105
- }
106
- };
107
- this.options = (opts = {})=>{
108
- let { element: element } = opts;
109
- element = element || this.listbox;
110
- let options = [];
111
- if (element) options = (0, $f8PS3$testinglibraryreact.within)(element).queryAllByRole('option');
112
- return options;
113
- };
114
148
  let { root: root, trigger: trigger, user: user, interactionType: interactionType } = opts;
115
149
  this.user = user;
116
150
  this._interactionType = interactionType || 'mouse';
@@ -1 +1 @@
1
- {"mappings":";;;;;;;;AAAA;;;;;;;;;;CAUC;AAUM,MAAM;IAkIX,IAAI,WAAW;QACb,OAAO,IAAI,CAAC,SAAS;IACvB;IAEA,IAAI,UAAU;QACZ,OAAO,IAAI,CAAC,QAAQ;IACtB;IAEA,IAAI,UAAU;QACZ,IAAI,YAAY,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;QAC3C,OAAO,YAAY,SAAS,cAAc,CAAC,cAAc,YAAY;IACvE;IAaA,IAAI,WAAW;QACb,IAAI,UAAU,IAAI,CAAC,OAAO;QAC1B,IAAI,SACF,OAAO,CAAA,GAAA,iCAAK,EAAE,SAAS,cAAc,CAAC;aAEtC,OAAO,EAAE;IAEb;IAEA,IAAI,gBAAgB;QAClB,IAAI,kBAAkB,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;QACjD,OAAO,kBAAkB,SAAS,cAAc,CAAC,mBAAmB;IACtE;IAhKA,YAAY,IAAqB,CAAE;aA4BnC,qBAAqB,CAAC;YACpB,IAAI,CAAC,gBAAgB,GAAG;QAC1B;aAEA,OAAO,OAAO,OAA8F,CAAC,CAAC;YAC5G,IAAI,mBAAC,kBAAkB,2BAAU,kBAAkB,IAAI,CAAC,gBAAgB,EAAC,GAAG;YAC5E,IAAI,UAAU,IAAI,CAAC,OAAO;YAC1B,IAAI,WAAW,IAAI,CAAC,QAAQ;YAC5B,IAAI,aAAa,QAAS,YAAY,CAAC;YAEvC,IAAI,oBAAoB;gBACtB,IAAI,oBAAoB,SACtB,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;qBAEtB,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;mBAEnB,IAAI,oBAAoB,cAAc,IAAI,CAAC,QAAQ,IAAI,MAAM;gBAClE,CAAA,GAAA,8BAAE,EAAE,IAAM,IAAI,CAAC,QAAQ,CAAE,KAAK;gBAC9B,IAAI,oBAAoB,SACtB,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YAE7B,OAAO,IAAI,oBAAoB;gBAC7B,IAAI,oBAAoB,SACtB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;oBAAC,QAAQ;oBAAU,MAAM;gBAAU;qBAE3D,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;oBAAC,QAAQ;oBAAS,MAAM;gBAAU;;YAI9D,MAAM,CAAA,GAAA,kCAAM,EAAE;gBACZ,IAAI,CAAC,cAAc,SAAS,YAAY,CAAC,oBAAoB,MAC3D,MAAM,IAAI,MAAM;qBAEhB,OAAO;YAEX;YACA,IAAI,YAAY,SAAS,YAAY,CAAC;YACtC,MAAM,CAAA,GAAA,kCAAM,EAAE;gBACZ,IAAI,CAAC,cAAe,CAAA,CAAC,aAAa,SAAS,cAAc,CAAC,cAAc,IAAG,GACzE,MAAM,IAAI,MAAM,CAAC,mBAAmB,EAAE,UAAU,uBAAuB,CAAC;qBAExE,OAAO;YAEX;QACF;aAEA,eAAe,OAAO,OAAyI,CAAC,CAAC;YAC/J,IAAI,cAAC,UAAU,UAAE,MAAM,mBAAE,eAAe,mBAAE,kBAAkB,IAAI,CAAC,gBAAgB,EAAC,GAAG;YACrF,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,kBAC9B,MAAM,IAAI,CAAC,IAAI,CAAC;iCAAC;YAAe;YAGlC,IAAI,UAAU,IAAI,CAAC,OAAO;YAC1B,IAAI,SAAS;gBACX,IAAI,CAAC,UAAU,YACb,SAAS,CAAA,GAAA,iCAAK,EAAE,SAAS,SAAS,CAAC;gBAGrC,8HAA8H;gBAC9H,wGAAwG;gBACxG,IAAI,oBAAoB,WAAW,oBAAoB,YACrD,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;qBAEtB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;oBAAC,QAAQ;oBAAQ,MAAM;gBAAU;gBAG3D,IAAI,UAAU,OAAO,YAAY,CAAC,WAAW,MAC3C,MAAM,CAAA,GAAA,kCAAM,EAAE;oBACZ,IAAI,SAAS,QAAQ,CAAC,UACpB,MAAM,IAAI,MAAM;yBAEhB,OAAO;gBAEX;YAEJ,OACE,MAAM,IAAI,MAAM;QAEpB;aAEA,QAAQ;YACN,IAAI,UAAU,IAAI,CAAC,OAAO;YAC1B,IAAI,SAAS;gBACX,CAAA,GAAA,8BAAE,EAAE,IAAM,IAAI,CAAC,QAAQ,CAAC,KAAK;gBAC7B,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;gBAEzB,MAAM,CAAA,GAAA,kCAAM,EAAE;oBACZ,IAAI,SAAS,QAAQ,CAAC,UACpB,MAAM,IAAI,MAAM;yBAEhB,OAAO;gBAEX;YACF;QACF;aAeA,UAAU,CAAC,OAAgC,CAAC,CAAC;YAC3C,IAAI,WAAC,OAAO,EAAC,GAAG;YAChB,UAAU,WAAW,IAAI,CAAC,OAAO;YACjC,IAAI,UAAU,EAAE;YAChB,IAAI,SACF,UAAU,CAAA,GAAA,iCAAK,EAAE,SAAS,cAAc,CAAC;YAG3C,OAAO;QACT;QAjJE,IAAI,QAAC,IAAI,WAAE,OAAO,QAAE,IAAI,mBAAE,eAAe,EAAC,GAAG;QAC7C,IAAI,CAAC,IAAI,GAAG;QACZ,IAAI,CAAC,gBAAgB,GAAG,mBAAmB;QAE3C,8IAA8I;QAC9I,2FAA2F;QAC3F,IAAI,CAAC,SAAS,GAAG;QACjB,IAAI,WAAW,CAAA,GAAA,iCAAK,EAAE,MAAM,WAAW,CAAC;QACxC,IAAI,UACF,IAAI,CAAC,SAAS,GAAG;QAGnB,6KAA6K;QAC7K,IAAI,SACF,IAAI,CAAC,QAAQ,GAAG;aACX;YACL,IAAI,UAAU,CAAA,GAAA,iCAAK,EAAE,MAAM,WAAW,CAAC,UAAU;gBAAC,QAAQ;YAAI;YAC9D,IAAI,SACF,IAAI,CAAC,QAAQ,GAAG;iBAEhB,qHAAqH;YACrH,6BAA6B;YAC7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS;QAElC;IACF;AAuIF","sources":["packages/@react-aria/test-utils/src/combobox.ts"],"sourcesContent":["/*\n * Copyright 2024 Adobe. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport {act, waitFor, within} from '@testing-library/react';\nimport {BaseTesterOpts, UserOpts} from './user';\n\nexport interface ComboBoxOptions extends UserOpts, BaseTesterOpts {\n user?: any,\n trigger?: HTMLElement\n}\n\nexport class ComboBoxTester {\n private user;\n private _interactionType: UserOpts['interactionType'];\n private _combobox: HTMLElement;\n private _trigger: HTMLElement | undefined;\n\n constructor(opts: ComboBoxOptions) {\n let {root, trigger, user, interactionType} = opts;\n this.user = user;\n this._interactionType = interactionType || 'mouse';\n\n // Handle case where element provided is a wrapper around the combobox. The expectation is that the user at least uses a ref/data attribute to\n // query their combobox/combobox wrapper (in the case of RSP) which they then pass to thhis\n this._combobox = root;\n let combobox = within(root).queryByRole('combobox');\n if (combobox) {\n this._combobox = combobox;\n }\n\n // This is for if user need to directly set the trigger button element (aka the element provided in setElement was the combobox input or the trigger is somewhere unexpected)\n if (trigger) {\n this._trigger = trigger;\n } else {\n let trigger = within(root).queryByRole('button', {hidden: true});\n if (trigger) {\n this._trigger = trigger;\n } else {\n // For cases like https://www.w3.org/WAI/ARIA/apg/patterns/combobox/examples/combobox-select-only/ where the combobox\n // is also the trigger button\n this._trigger = this._combobox;\n }\n }\n }\n\n setInteractionType = (type: UserOpts['interactionType']) => {\n this._interactionType = type;\n };\n\n open = async (opts: {triggerBehavior?: 'focus' | 'manual', interactionType?: UserOpts['interactionType']} = {}) => {\n let {triggerBehavior = 'manual', interactionType = this._interactionType} = opts;\n let trigger = this.trigger;\n let combobox = this.combobox;\n let isDisabled = trigger!.hasAttribute('disabled');\n\n if (interactionType === 'mouse') {\n if (triggerBehavior === 'focus') {\n await this.user.click(combobox);\n } else {\n await this.user.click(trigger);\n }\n } else if (interactionType === 'keyboard' && this._trigger != null) {\n act(() => this._trigger!.focus());\n if (triggerBehavior !== 'focus') {\n await this.user.keyboard('{ArrowDown}');\n }\n } else if (interactionType === 'touch') {\n if (triggerBehavior === 'focus') {\n await this.user.pointer({target: combobox, keys: '[TouchA]'});\n } else {\n await this.user.pointer({target: trigger, keys: '[TouchA]'});\n }\n }\n\n await waitFor(() => {\n if (!isDisabled && combobox.getAttribute('aria-controls') == null) {\n throw new Error('No aria-controls found on combobox trigger element.');\n } else {\n return true;\n }\n });\n let listBoxId = combobox.getAttribute('aria-controls');\n await waitFor(() => {\n if (!isDisabled && (!listBoxId || document.getElementById(listBoxId) == null)) {\n throw new Error(`Listbox with id of ${listBoxId} not found in document.`);\n } else {\n return true;\n }\n });\n };\n\n selectOption = async (opts: {option?: HTMLElement, optionText?: string, triggerBehavior?: 'focus' | 'manual', interactionType?: UserOpts['interactionType']} = {}) => {\n let {optionText, option, triggerBehavior, interactionType = this._interactionType} = opts;\n if (!this.combobox.getAttribute('aria-controls')) {\n await this.open({triggerBehavior});\n }\n\n let listbox = this.listbox;\n if (listbox) {\n if (!option && optionText) {\n option = within(listbox).getByText(optionText);\n }\n\n // TODO: keyboard method of selecting the the option is a bit tricky unless I simply simulate the user pressing the down arrow\n // the required amount of times to reach the option. For now just click the option even in keyboard mode\n if (interactionType === 'mouse' || interactionType === 'keyboard') {\n await this.user.click(option);\n } else {\n await this.user.pointer({target: option, keys: '[TouchA]'});\n }\n\n if (option && option.getAttribute('href') == null) {\n await waitFor(() => {\n if (document.contains(listbox)) {\n throw new Error('Expected listbox element to not be in the document after selecting an option');\n } else {\n return true;\n }\n });\n }\n } else {\n throw new Error(\"Attempted to select a option in the combobox, but the listbox wasn't found.\");\n }\n };\n\n close = async () => {\n let listbox = this.listbox;\n if (listbox) {\n act(() => this.combobox.focus());\n await this.user.keyboard('[Escape]');\n\n await waitFor(() => {\n if (document.contains(listbox)) {\n throw new Error('Expected listbox element to not be in the document after selecting an option');\n } else {\n return true;\n }\n });\n }\n };\n\n get combobox() {\n return this._combobox;\n }\n\n get trigger() {\n return this._trigger;\n }\n\n get listbox() {\n let listBoxId = this.combobox.getAttribute('aria-controls');\n return listBoxId ? document.getElementById(listBoxId) || undefined : undefined;\n }\n\n options = (opts: {element?: HTMLElement} = {}): HTMLElement[] | never[] => {\n let {element} = opts;\n element = element || this.listbox;\n let options = [];\n if (element) {\n options = within(element).queryAllByRole('option');\n }\n\n return options;\n };\n\n get sections() {\n let listbox = this.listbox;\n if (listbox) {\n return within(listbox).queryAllByRole('group');\n } else {\n return [];\n }\n }\n\n get focusedOption() {\n let focusedOptionId = this.combobox.getAttribute('aria-activedescendant');\n return focusedOptionId ? document.getElementById(focusedOptionId) : undefined;\n }\n}\n"],"names":[],"version":3,"file":"combobox.main.js.map"}
1
+ {"mappings":";;;;;;;;AAAA;;;;;;;;;;CAUC;AAwBM,MAAM;IAkCX;;GAEC,GACD,mBAAmB,IAAiC,EAAE;QACpD,IAAI,CAAC,gBAAgB,GAAG;IAC1B;IAEA;;GAEC,GACD,MAAM,KAAK,OAAyB,CAAC,CAAC,EAAE;QACtC,IAAI,mBAAC,kBAAkB,2BAAU,kBAAkB,IAAI,CAAC,gBAAgB,EAAC,GAAG;QAC5E,IAAI,UAAU,IAAI,CAAC,OAAO;QAC1B,IAAI,WAAW,IAAI,CAAC,QAAQ;QAC5B,IAAI,aAAa,QAAS,YAAY,CAAC;QAEvC,IAAI,oBAAoB;YACtB,IAAI,oBAAoB,SACtB,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;iBAEtB,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;eAEnB,IAAI,oBAAoB,cAAc,IAAI,CAAC,QAAQ,IAAI,MAAM;YAClE,CAAA,GAAA,8BAAE,EAAE,IAAM,IAAI,CAAC,QAAQ,CAAE,KAAK;YAC9B,IAAI,oBAAoB,SACtB,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;QAE7B,OAAO,IAAI,oBAAoB;YAC7B,IAAI,oBAAoB,SACtB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;gBAAC,QAAQ;gBAAU,MAAM;YAAU;iBAE3D,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;gBAAC,QAAQ;gBAAS,MAAM;YAAU;;QAI9D,MAAM,CAAA,GAAA,kCAAM,EAAE;YACZ,IAAI,CAAC,cAAc,SAAS,YAAY,CAAC,oBAAoB,MAC3D,MAAM,IAAI,MAAM;iBAEhB,OAAO;QAEX;QACA,IAAI,YAAY,SAAS,YAAY,CAAC;QACtC,MAAM,CAAA,GAAA,kCAAM,EAAE;YACZ,IAAI,CAAC,cAAe,CAAA,CAAC,aAAa,SAAS,cAAc,CAAC,cAAc,IAAG,GACzE,MAAM,IAAI,MAAM,CAAC,mBAAmB,EAAE,UAAU,uBAAuB,CAAC;iBAExE,OAAO;QAEX;IACF;IAEA;;GAEC,GACD,WAAW,IAA0C,EAAe;QAClE,IAAI,qBACF,iBAAiB,EAClB,GAAG;QAEJ,IAAI;QACJ,IAAI,UAAU,IAAI,CAAC,OAAO;QAC1B,IAAI,UAAU,IAAI,CAAC,OAAO;QAE1B,IAAI,OAAO,sBAAsB,UAC/B,SAAS,OAAO,CAAC,kBAAkB;aAC9B,IAAI,OAAO,sBAAsB,YAAY,WAAW,MAC7D,SAAU,CAAA,GAAA,iCAAK,EAAE,SAAU,SAAS,CAAC,mBAAmB,OAAO,CAAC;QAGlE,OAAO;IACT;IAEA;;;GAGC,GACD,MAAM,aAAa,IAAwB,EAAE;QAC3C,IAAI,UAAC,MAAM,mBAAE,eAAe,mBAAE,kBAAkB,IAAI,CAAC,gBAAgB,EAAC,GAAG;QACzE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC,kBAC9B,MAAM,IAAI,CAAC,IAAI,CAAC;6BAAC;QAAe;QAGlC,IAAI,UAAU,IAAI,CAAC,OAAO;QAC1B,IAAI,CAAC,SACH,MAAM,IAAI,MAAM;QAGlB,IAAI,SAAS;YACX,IAAI,OAAO,WAAW,YAAY,OAAO,WAAW,UAClD,SAAS,IAAI,CAAC,UAAU,CAAC;gBAAC,mBAAmB;YAAM;YAGrD,IAAI,CAAC,QACH,MAAM,IAAI,MAAM;YAGlB,8HAA8H;YAC9H,wGAAwG;YACxG,IAAI,oBAAoB,WAAW,oBAAoB,YACrD,MAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC;iBAEtB,MAAM,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC;gBAAC,QAAQ;gBAAQ,MAAM;YAAU;YAG3D,IAAI,OAAO,YAAY,CAAC,WAAW,MACjC,MAAM,CAAA,GAAA,kCAAM,EAAE;gBACZ,IAAI,SAAS,QAAQ,CAAC,UACpB,MAAM,IAAI,MAAM;qBAEhB,OAAO;YAEX;QAEJ,OACE,MAAM,IAAI,MAAM;IAEpB;IAEA;;GAEC,GACD,MAAM,QAAQ;QACZ,IAAI,UAAU,IAAI,CAAC,OAAO;QAC1B,IAAI,SAAS;YACX,CAAA,GAAA,8BAAE,EAAE,IAAM,IAAI,CAAC,QAAQ,CAAC,KAAK;YAC7B,MAAM,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC;YAEzB,MAAM,CAAA,GAAA,kCAAM,EAAE;gBACZ,IAAI,SAAS,QAAQ,CAAC,UACpB,MAAM,IAAI,MAAM;qBAEhB,OAAO;YAEX;QACF;IACF;IAEA;;GAEC,GACD,IAAI,WAAwB;QAC1B,OAAO,IAAI,CAAC,SAAS;IACvB;IAEA;;GAEC,GACD,IAAI,UAAuB;QACzB,OAAO,IAAI,CAAC,QAAQ;IACtB;IAEA;;GAEC,GACD,IAAI,UAA8B;QAChC,IAAI,YAAY,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;QAC3C,OAAO,YAAY,SAAS,cAAc,CAAC,cAAc,OAAO;IAClE;IAEA;;GAEC,GACD,IAAI,WAA0B;QAC5B,IAAI,UAAU,IAAI,CAAC,OAAO;QAC1B,OAAO,UAAU,CAAA,GAAA,iCAAK,EAAE,SAAS,cAAc,CAAC,WAAW,EAAE;IAC/D;IAEA;;GAEC,GACD,QAAQ,OAAgC,CAAC,CAAC,EAAiB;QACzD,IAAI,WAAC,UAAU,IAAI,CAAC,OAAO,EAAC,GAAG;QAC/B,IAAI,UAAU,EAAE;QAChB,IAAI,SACF,UAAU,CAAA,GAAA,iCAAK,EAAE,SAAS,cAAc,CAAC;QAG3C,OAAO;IACT;IAEA;;GAEC,GACD,IAAI,gBAAoC;QACtC,IAAI,kBAAkB,IAAI,CAAC,QAAQ,CAAC,YAAY,CAAC;QACjD,OAAO,kBAAkB,SAAS,cAAc,CAAC,mBAAmB;IACtE;IAvNA,YAAY,IAAwB,CAAE;QACpC,IAAI,QAAC,IAAI,WAAE,OAAO,QAAE,IAAI,mBAAE,eAAe,EAAC,GAAG;QAC7C,IAAI,CAAC,IAAI,GAAG;QACZ,IAAI,CAAC,gBAAgB,GAAG,mBAAmB;QAE3C,8IAA8I;QAC9I,2FAA2F;QAC3F,IAAI,CAAC,SAAS,GAAG;QACjB,IAAI,WAAW,CAAA,GAAA,iCAAK,EAAE,MAAM,WAAW,CAAC;QACxC,IAAI,UACF,IAAI,CAAC,SAAS,GAAG;QAGnB,6KAA6K;QAC7K,IAAI,SACF,IAAI,CAAC,QAAQ,GAAG;aACX;YACL,IAAI,UAAU,CAAA,GAAA,iCAAK,EAAE,MAAM,WAAW,CAAC,UAAU;gBAAC,QAAQ;YAAI;YAC9D,IAAI,SACF,IAAI,CAAC,QAAQ,GAAG;iBAEhB,qHAAqH;YACrH,6BAA6B;YAC7B,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC,SAAS;QAElC;IACF;AA8LF","sources":["packages/@react-aria/test-utils/src/combobox.ts"],"sourcesContent":["/*\n * Copyright 2024 Adobe. All rights reserved.\n * This file is licensed to you under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License. You may obtain a copy\n * of the License at http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software distributed under\n * the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS\n * OF ANY KIND, either express or implied. See the License for the specific language\n * governing permissions and limitations under the License.\n */\n\nimport {act, waitFor, within} from '@testing-library/react';\nimport {ComboBoxTesterOpts, UserOpts} from './types';\n\ninterface ComboBoxOpenOpts {\n /**\n * Whether the combobox opens on focus or needs to be manually opened via user action.\n * @default 'manual'\n */\n triggerBehavior?: 'focus' | 'manual',\n /**\n * What interaction type to use when opening the combobox. Defaults to the interaction type set on the tester.\n */\n interactionType?: UserOpts['interactionType']\n}\n\ninterface ComboBoxSelectOpts extends ComboBoxOpenOpts {\n /**\n * The index, text, or node of the option to select. Option nodes can be sourced via `options()`.\n */\n option: number | string | HTMLElement\n}\n\nexport class ComboBoxTester {\n private user;\n private _interactionType: UserOpts['interactionType'];\n private _combobox: HTMLElement;\n private _trigger: HTMLElement;\n\n constructor(opts: ComboBoxTesterOpts) {\n let {root, trigger, user, interactionType} = opts;\n this.user = user;\n this._interactionType = interactionType || 'mouse';\n\n // Handle case where element provided is a wrapper around the combobox. The expectation is that the user at least uses a ref/data attribute to\n // query their combobox/combobox wrapper (in the case of RSP) which they then pass to thhis\n this._combobox = root;\n let combobox = within(root).queryByRole('combobox');\n if (combobox) {\n this._combobox = combobox;\n }\n\n // This is for if user need to directly set the trigger button element (aka the element provided in setElement was the combobox input or the trigger is somewhere unexpected)\n if (trigger) {\n this._trigger = trigger;\n } else {\n let trigger = within(root).queryByRole('button', {hidden: true});\n if (trigger) {\n this._trigger = trigger;\n } else {\n // For cases like https://www.w3.org/WAI/ARIA/apg/patterns/combobox/examples/combobox-select-only/ where the combobox\n // is also the trigger button\n this._trigger = this._combobox;\n }\n }\n }\n\n /**\n * Set the interaction type used by the combobox tester.\n */\n setInteractionType(type: UserOpts['interactionType']) {\n this._interactionType = type;\n }\n\n /**\n * Opens the combobox dropdown. Defaults to using the interaction type set on the combobox tester.\n */\n async open(opts: ComboBoxOpenOpts = {}) {\n let {triggerBehavior = 'manual', interactionType = this._interactionType} = opts;\n let trigger = this.trigger;\n let combobox = this.combobox;\n let isDisabled = trigger!.hasAttribute('disabled');\n\n if (interactionType === 'mouse') {\n if (triggerBehavior === 'focus') {\n await this.user.click(combobox);\n } else {\n await this.user.click(trigger);\n }\n } else if (interactionType === 'keyboard' && this._trigger != null) {\n act(() => this._trigger!.focus());\n if (triggerBehavior !== 'focus') {\n await this.user.keyboard('{ArrowDown}');\n }\n } else if (interactionType === 'touch') {\n if (triggerBehavior === 'focus') {\n await this.user.pointer({target: combobox, keys: '[TouchA]'});\n } else {\n await this.user.pointer({target: trigger, keys: '[TouchA]'});\n }\n }\n\n await waitFor(() => {\n if (!isDisabled && combobox.getAttribute('aria-controls') == null) {\n throw new Error('No aria-controls found on combobox trigger element.');\n } else {\n return true;\n }\n });\n let listBoxId = combobox.getAttribute('aria-controls');\n await waitFor(() => {\n if (!isDisabled && (!listBoxId || document.getElementById(listBoxId) == null)) {\n throw new Error(`Listbox with id of ${listBoxId} not found in document.`);\n } else {\n return true;\n }\n });\n }\n\n /**\n * Returns an option matching the specified index or text content.\n */\n findOption(opts: {optionIndexOrText: number | string}): HTMLElement {\n let {\n optionIndexOrText\n } = opts;\n\n let option;\n let options = this.options();\n let listbox = this.listbox;\n\n if (typeof optionIndexOrText === 'number') {\n option = options[optionIndexOrText];\n } else if (typeof optionIndexOrText === 'string' && listbox != null) {\n option = (within(listbox!).getByText(optionIndexOrText).closest('[role=option]'))! as HTMLElement;\n }\n\n return option;\n }\n\n /**\n * Selects the desired combobox option. Defaults to using the interaction type set on the combobox tester. If necessary, will open the combobox dropdown beforehand.\n * The desired option can be targeted via the option's node, the option's text, or the option's index.\n */\n async selectOption(opts: ComboBoxSelectOpts) {\n let {option, triggerBehavior, interactionType = this._interactionType} = opts;\n if (!this.combobox.getAttribute('aria-controls')) {\n await this.open({triggerBehavior});\n }\n\n let listbox = this.listbox;\n if (!listbox) {\n throw new Error('Combobox\\'s listbox not found.');\n }\n\n if (listbox) {\n if (typeof option === 'string' || typeof option === 'number') {\n option = this.findOption({optionIndexOrText: option});\n }\n\n if (!option) {\n throw new Error('Target option not found in the listbox.');\n }\n\n // TODO: keyboard method of selecting the the option is a bit tricky unless I simply simulate the user pressing the down arrow\n // the required amount of times to reach the option. For now just click the option even in keyboard mode\n if (interactionType === 'mouse' || interactionType === 'keyboard') {\n await this.user.click(option);\n } else {\n await this.user.pointer({target: option, keys: '[TouchA]'});\n }\n\n if (option.getAttribute('href') == null) {\n await waitFor(() => {\n if (document.contains(listbox)) {\n throw new Error('Expected listbox element to not be in the document after selecting an option');\n } else {\n return true;\n }\n });\n }\n } else {\n throw new Error(\"Attempted to select a option in the combobox, but the listbox wasn't found.\");\n }\n }\n\n /**\n * Closes the combobox dropdown.\n */\n async close() {\n let listbox = this.listbox;\n if (listbox) {\n act(() => this.combobox.focus());\n await this.user.keyboard('[Escape]');\n\n await waitFor(() => {\n if (document.contains(listbox)) {\n throw new Error('Expected listbox element to not be in the document after selecting an option');\n } else {\n return true;\n }\n });\n }\n }\n\n /**\n * Returns the combobox.\n */\n get combobox(): HTMLElement {\n return this._combobox;\n }\n\n /**\n * Returns the combobox trigger button.\n */\n get trigger(): HTMLElement {\n return this._trigger;\n }\n\n /**\n * Returns the combobox's listbox if present.\n */\n get listbox(): HTMLElement | null {\n let listBoxId = this.combobox.getAttribute('aria-controls');\n return listBoxId ? document.getElementById(listBoxId) || null : null;\n }\n\n /**\n * Returns the combobox's sections if present.\n */\n get sections(): HTMLElement[] {\n let listbox = this.listbox;\n return listbox ? within(listbox).queryAllByRole('group') : [];\n }\n\n /**\n * Returns the combobox's options if present. Can be filtered to a subsection of the listbox if provided via `element`.\n */\n options(opts: {element?: HTMLElement} = {}): HTMLElement[] {\n let {element = this.listbox} = opts;\n let options = [];\n if (element) {\n options = within(element).queryAllByRole('option');\n }\n\n return options;\n }\n\n /**\n * Returns the currently focused option in the combobox's dropdown if any.\n */\n get focusedOption(): HTMLElement | null {\n let focusedOptionId = this.combobox.getAttribute('aria-activedescendant');\n return focusedOptionId ? document.getElementById(focusedOptionId) : null;\n }\n}\n"],"names":[],"version":3,"file":"combobox.main.js.map"}
package/dist/combobox.mjs CHANGED
@@ -1,4 +1,4 @@
1
- import {within as $1n52X$within, act as $1n52X$act, waitFor as $1n52X$waitFor} from "@testing-library/react";
1
+ import {act as $1n52X$act, waitFor as $1n52X$waitFor, within as $1n52X$within} from "@testing-library/react";
2
2
 
3
3
  /*
4
4
  * Copyright 2024 Adobe. All rights reserved.
@@ -12,99 +12,133 @@ import {within as $1n52X$within, act as $1n52X$act, waitFor as $1n52X$waitFor} f
12
12
  * governing permissions and limitations under the License.
13
13
  */
14
14
  class $dab75f394483aa9c$export$f97e14e96d71ab3b {
15
- get combobox() {
15
+ /**
16
+ * Set the interaction type used by the combobox tester.
17
+ */ setInteractionType(type) {
18
+ this._interactionType = type;
19
+ }
20
+ /**
21
+ * Opens the combobox dropdown. Defaults to using the interaction type set on the combobox tester.
22
+ */ async open(opts = {}) {
23
+ let { triggerBehavior: triggerBehavior = 'manual', interactionType: interactionType = this._interactionType } = opts;
24
+ let trigger = this.trigger;
25
+ let combobox = this.combobox;
26
+ let isDisabled = trigger.hasAttribute('disabled');
27
+ if (interactionType === 'mouse') {
28
+ if (triggerBehavior === 'focus') await this.user.click(combobox);
29
+ else await this.user.click(trigger);
30
+ } else if (interactionType === 'keyboard' && this._trigger != null) {
31
+ (0, $1n52X$act)(()=>this._trigger.focus());
32
+ if (triggerBehavior !== 'focus') await this.user.keyboard('{ArrowDown}');
33
+ } else if (interactionType === 'touch') {
34
+ if (triggerBehavior === 'focus') await this.user.pointer({
35
+ target: combobox,
36
+ keys: '[TouchA]'
37
+ });
38
+ else await this.user.pointer({
39
+ target: trigger,
40
+ keys: '[TouchA]'
41
+ });
42
+ }
43
+ await (0, $1n52X$waitFor)(()=>{
44
+ if (!isDisabled && combobox.getAttribute('aria-controls') == null) throw new Error('No aria-controls found on combobox trigger element.');
45
+ else return true;
46
+ });
47
+ let listBoxId = combobox.getAttribute('aria-controls');
48
+ await (0, $1n52X$waitFor)(()=>{
49
+ if (!isDisabled && (!listBoxId || document.getElementById(listBoxId) == null)) throw new Error(`Listbox with id of ${listBoxId} not found in document.`);
50
+ else return true;
51
+ });
52
+ }
53
+ /**
54
+ * Returns an option matching the specified index or text content.
55
+ */ findOption(opts) {
56
+ let { optionIndexOrText: optionIndexOrText } = opts;
57
+ let option;
58
+ let options = this.options();
59
+ let listbox = this.listbox;
60
+ if (typeof optionIndexOrText === 'number') option = options[optionIndexOrText];
61
+ else if (typeof optionIndexOrText === 'string' && listbox != null) option = (0, $1n52X$within)(listbox).getByText(optionIndexOrText).closest('[role=option]');
62
+ return option;
63
+ }
64
+ /**
65
+ * Selects the desired combobox option. Defaults to using the interaction type set on the combobox tester. If necessary, will open the combobox dropdown beforehand.
66
+ * The desired option can be targeted via the option's node, the option's text, or the option's index.
67
+ */ async selectOption(opts) {
68
+ let { option: option, triggerBehavior: triggerBehavior, interactionType: interactionType = this._interactionType } = opts;
69
+ if (!this.combobox.getAttribute('aria-controls')) await this.open({
70
+ triggerBehavior: triggerBehavior
71
+ });
72
+ let listbox = this.listbox;
73
+ if (!listbox) throw new Error('Combobox\'s listbox not found.');
74
+ if (listbox) {
75
+ if (typeof option === 'string' || typeof option === 'number') option = this.findOption({
76
+ optionIndexOrText: option
77
+ });
78
+ if (!option) throw new Error('Target option not found in the listbox.');
79
+ // TODO: keyboard method of selecting the the option is a bit tricky unless I simply simulate the user pressing the down arrow
80
+ // the required amount of times to reach the option. For now just click the option even in keyboard mode
81
+ if (interactionType === 'mouse' || interactionType === 'keyboard') await this.user.click(option);
82
+ else await this.user.pointer({
83
+ target: option,
84
+ keys: '[TouchA]'
85
+ });
86
+ if (option.getAttribute('href') == null) await (0, $1n52X$waitFor)(()=>{
87
+ if (document.contains(listbox)) throw new Error('Expected listbox element to not be in the document after selecting an option');
88
+ else return true;
89
+ });
90
+ } else throw new Error("Attempted to select a option in the combobox, but the listbox wasn't found.");
91
+ }
92
+ /**
93
+ * Closes the combobox dropdown.
94
+ */ async close() {
95
+ let listbox = this.listbox;
96
+ if (listbox) {
97
+ (0, $1n52X$act)(()=>this.combobox.focus());
98
+ await this.user.keyboard('[Escape]');
99
+ await (0, $1n52X$waitFor)(()=>{
100
+ if (document.contains(listbox)) throw new Error('Expected listbox element to not be in the document after selecting an option');
101
+ else return true;
102
+ });
103
+ }
104
+ }
105
+ /**
106
+ * Returns the combobox.
107
+ */ get combobox() {
16
108
  return this._combobox;
17
109
  }
18
- get trigger() {
110
+ /**
111
+ * Returns the combobox trigger button.
112
+ */ get trigger() {
19
113
  return this._trigger;
20
114
  }
21
- get listbox() {
115
+ /**
116
+ * Returns the combobox's listbox if present.
117
+ */ get listbox() {
22
118
  let listBoxId = this.combobox.getAttribute('aria-controls');
23
- return listBoxId ? document.getElementById(listBoxId) || undefined : undefined;
119
+ return listBoxId ? document.getElementById(listBoxId) || null : null;
24
120
  }
25
- get sections() {
121
+ /**
122
+ * Returns the combobox's sections if present.
123
+ */ get sections() {
26
124
  let listbox = this.listbox;
27
- if (listbox) return (0, $1n52X$within)(listbox).queryAllByRole('group');
28
- else return [];
125
+ return listbox ? (0, $1n52X$within)(listbox).queryAllByRole('group') : [];
126
+ }
127
+ /**
128
+ * Returns the combobox's options if present. Can be filtered to a subsection of the listbox if provided via `element`.
129
+ */ options(opts = {}) {
130
+ let { element: element = this.listbox } = opts;
131
+ let options = [];
132
+ if (element) options = (0, $1n52X$within)(element).queryAllByRole('option');
133
+ return options;
29
134
  }
30
- get focusedOption() {
135
+ /**
136
+ * Returns the currently focused option in the combobox's dropdown if any.
137
+ */ get focusedOption() {
31
138
  let focusedOptionId = this.combobox.getAttribute('aria-activedescendant');
32
- return focusedOptionId ? document.getElementById(focusedOptionId) : undefined;
139
+ return focusedOptionId ? document.getElementById(focusedOptionId) : null;
33
140
  }
34
141
  constructor(opts){
35
- this.setInteractionType = (type)=>{
36
- this._interactionType = type;
37
- };
38
- this.open = async (opts = {})=>{
39
- let { triggerBehavior: triggerBehavior = 'manual', interactionType: interactionType = this._interactionType } = opts;
40
- let trigger = this.trigger;
41
- let combobox = this.combobox;
42
- let isDisabled = trigger.hasAttribute('disabled');
43
- if (interactionType === 'mouse') {
44
- if (triggerBehavior === 'focus') await this.user.click(combobox);
45
- else await this.user.click(trigger);
46
- } else if (interactionType === 'keyboard' && this._trigger != null) {
47
- (0, $1n52X$act)(()=>this._trigger.focus());
48
- if (triggerBehavior !== 'focus') await this.user.keyboard('{ArrowDown}');
49
- } else if (interactionType === 'touch') {
50
- if (triggerBehavior === 'focus') await this.user.pointer({
51
- target: combobox,
52
- keys: '[TouchA]'
53
- });
54
- else await this.user.pointer({
55
- target: trigger,
56
- keys: '[TouchA]'
57
- });
58
- }
59
- await (0, $1n52X$waitFor)(()=>{
60
- if (!isDisabled && combobox.getAttribute('aria-controls') == null) throw new Error('No aria-controls found on combobox trigger element.');
61
- else return true;
62
- });
63
- let listBoxId = combobox.getAttribute('aria-controls');
64
- await (0, $1n52X$waitFor)(()=>{
65
- if (!isDisabled && (!listBoxId || document.getElementById(listBoxId) == null)) throw new Error(`Listbox with id of ${listBoxId} not found in document.`);
66
- else return true;
67
- });
68
- };
69
- this.selectOption = async (opts = {})=>{
70
- let { optionText: optionText, option: option, triggerBehavior: triggerBehavior, interactionType: interactionType = this._interactionType } = opts;
71
- if (!this.combobox.getAttribute('aria-controls')) await this.open({
72
- triggerBehavior: triggerBehavior
73
- });
74
- let listbox = this.listbox;
75
- if (listbox) {
76
- if (!option && optionText) option = (0, $1n52X$within)(listbox).getByText(optionText);
77
- // TODO: keyboard method of selecting the the option is a bit tricky unless I simply simulate the user pressing the down arrow
78
- // the required amount of times to reach the option. For now just click the option even in keyboard mode
79
- if (interactionType === 'mouse' || interactionType === 'keyboard') await this.user.click(option);
80
- else await this.user.pointer({
81
- target: option,
82
- keys: '[TouchA]'
83
- });
84
- if (option && option.getAttribute('href') == null) await (0, $1n52X$waitFor)(()=>{
85
- if (document.contains(listbox)) throw new Error('Expected listbox element to not be in the document after selecting an option');
86
- else return true;
87
- });
88
- } else throw new Error("Attempted to select a option in the combobox, but the listbox wasn't found.");
89
- };
90
- this.close = async ()=>{
91
- let listbox = this.listbox;
92
- if (listbox) {
93
- (0, $1n52X$act)(()=>this.combobox.focus());
94
- await this.user.keyboard('[Escape]');
95
- await (0, $1n52X$waitFor)(()=>{
96
- if (document.contains(listbox)) throw new Error('Expected listbox element to not be in the document after selecting an option');
97
- else return true;
98
- });
99
- }
100
- };
101
- this.options = (opts = {})=>{
102
- let { element: element } = opts;
103
- element = element || this.listbox;
104
- let options = [];
105
- if (element) options = (0, $1n52X$within)(element).queryAllByRole('option');
106
- return options;
107
- };
108
142
  let { root: root, trigger: trigger, user: user, interactionType: interactionType } = opts;
109
143
  this.user = user;
110
144
  this._interactionType = interactionType || 'mouse';