@testing-library/user-event 13.4.1 → 14.0.0-alpha.10

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 (122) hide show
  1. package/README.md +4 -0
  2. package/dist/clear.d.ts +2 -2
  3. package/dist/clear.js +14 -29
  4. package/dist/click.d.ts +4 -3
  5. package/dist/click.js +29 -143
  6. package/dist/document/index.d.ts +10 -0
  7. package/dist/document/index.js +100 -0
  8. package/dist/document/interceptor.d.ts +15 -0
  9. package/dist/document/interceptor.js +37 -0
  10. package/dist/document/selection.d.ts +27 -0
  11. package/dist/document/selection.js +90 -0
  12. package/dist/document/value.d.ts +18 -0
  13. package/dist/document/value.js +77 -0
  14. package/dist/hover.d.ts +3 -3
  15. package/dist/hover.js +15 -57
  16. package/dist/index.d.ts +4 -21
  17. package/dist/index.js +4 -29
  18. package/dist/keyboard/getNextKeyDef.d.ts +3 -0
  19. package/dist/keyboard/getNextKeyDef.js +59 -87
  20. package/dist/keyboard/index.d.ts +1 -0
  21. package/dist/keyboard/index.js +4 -0
  22. package/dist/keyboard/keyMap.js +4 -0
  23. package/dist/keyboard/keyboardImplementation.js +28 -8
  24. package/dist/keyboard/plugins/arrow.js +7 -12
  25. package/dist/keyboard/plugins/character.js +29 -57
  26. package/dist/keyboard/plugins/combination.d.ts +5 -0
  27. package/dist/keyboard/plugins/combination.js +17 -0
  28. package/dist/keyboard/plugins/control.js +5 -16
  29. package/dist/keyboard/plugins/functional.js +33 -15
  30. package/dist/keyboard/plugins/index.js +5 -5
  31. package/dist/keyboard/shared/index.d.ts +0 -2
  32. package/dist/keyboard/shared/index.js +0 -26
  33. package/dist/keyboard/types.d.ts +8 -0
  34. package/dist/paste.d.ts +3 -2
  35. package/dist/paste.js +8 -15
  36. package/dist/pointer/index.d.ts +18 -0
  37. package/dist/pointer/index.js +90 -0
  38. package/dist/pointer/keyMap.d.ts +2 -0
  39. package/dist/pointer/keyMap.js +29 -0
  40. package/dist/pointer/parseKeyDef.d.ts +6 -0
  41. package/dist/pointer/parseKeyDef.js +36 -0
  42. package/dist/pointer/pointerAction.d.ts +6 -0
  43. package/dist/pointer/pointerAction.js +52 -0
  44. package/dist/pointer/pointerMove.d.ts +5 -0
  45. package/dist/pointer/pointerMove.js +136 -0
  46. package/dist/pointer/pointerPress.d.ts +7 -0
  47. package/dist/pointer/pointerPress.js +330 -0
  48. package/dist/pointer/resolveSelectionTarget.d.ts +5 -0
  49. package/dist/pointer/resolveSelectionTarget.js +75 -0
  50. package/dist/pointer/types.d.ts +72 -0
  51. package/dist/pointer/types.js +1 -0
  52. package/dist/selectOptions.d.ts +4 -0
  53. package/dist/{select-options.js → selectOptions.js} +18 -20
  54. package/dist/setup.d.ts +92 -0
  55. package/dist/setup.js +203 -0
  56. package/dist/tab.d.ts +3 -4
  57. package/dist/tab.js +3 -136
  58. package/dist/type.d.ts +14 -0
  59. package/dist/type.js +74 -0
  60. package/dist/upload.d.ts +4 -3
  61. package/dist/upload.js +3 -9
  62. package/dist/utils/edit/calculateNewValue.d.ts +12 -5
  63. package/dist/utils/edit/calculateNewValue.js +19 -21
  64. package/dist/utils/edit/editInputElement.d.ts +16 -0
  65. package/dist/utils/edit/editInputElement.js +53 -0
  66. package/dist/utils/edit/getValue.d.ts +1 -1
  67. package/dist/utils/edit/getValue.js +3 -1
  68. package/dist/utils/edit/isContentEditable.d.ts +4 -0
  69. package/dist/utils/edit/isContentEditable.js +14 -0
  70. package/dist/utils/edit/isEditable.d.ts +1 -0
  71. package/dist/utils/edit/prepareInput.d.ts +7 -0
  72. package/dist/utils/edit/prepareInput.js +77 -0
  73. package/dist/{blur.d.ts → utils/focus/blur.d.ts} +0 -0
  74. package/dist/utils/focus/blur.js +19 -0
  75. package/dist/{focus.d.ts → utils/focus/focus.d.ts} +0 -0
  76. package/dist/utils/focus/focus.js +22 -0
  77. package/dist/utils/focus/getTabDestination.d.ts +1 -0
  78. package/dist/utils/focus/getTabDestination.js +71 -0
  79. package/dist/utils/focus/isFocusable.js +1 -3
  80. package/dist/utils/focus/selectAll.d.ts +5 -0
  81. package/dist/utils/focus/selectAll.js +51 -0
  82. package/dist/utils/focus/selection.d.ts +42 -0
  83. package/dist/utils/focus/selection.js +190 -0
  84. package/dist/utils/index.d.ts +13 -6
  85. package/dist/utils/index.js +145 -54
  86. package/dist/utils/keyDef/readNextDescriptor.d.ts +19 -0
  87. package/dist/utils/keyDef/readNextDescriptor.js +102 -0
  88. package/dist/utils/misc/findClosest.d.ts +1 -0
  89. package/dist/utils/misc/findClosest.js +20 -0
  90. package/dist/utils/misc/hasFormSubmit.d.ts +1 -0
  91. package/dist/utils/misc/hasFormSubmit.js +10 -0
  92. package/dist/utils/misc/isDescendantOrSelf.d.ts +1 -0
  93. package/dist/utils/misc/isDescendantOrSelf.js +20 -0
  94. package/dist/utils/pointer/firePointerEvents.d.ts +25 -0
  95. package/dist/utils/pointer/firePointerEvents.js +112 -0
  96. package/dist/utils/pointer/mouseButtons.d.ts +12 -0
  97. package/dist/utils/pointer/mouseButtons.js +45 -0
  98. package/package.json +4 -3
  99. package/dist/blur.js +0 -15
  100. package/dist/dom-helpers.d.ts +0 -3
  101. package/dist/focus.js +0 -15
  102. package/dist/keyboard/shared/carryValue.d.ts +0 -2
  103. package/dist/keyboard/shared/carryValue.js +0 -13
  104. package/dist/keyboard/shared/fireInputEvent.d.ts +0 -17
  105. package/dist/keyboard/shared/fireInputEvent.js +0 -110
  106. package/dist/select-options.d.ts +0 -4
  107. package/dist/type/index.d.ts +0 -7
  108. package/dist/type/index.js +0 -33
  109. package/dist/type/typeImplementation.d.ts +0 -10
  110. package/dist/type/typeImplementation.js +0 -64
  111. package/dist/utils/click/getMouseEventOptions.d.ts +0 -31
  112. package/dist/utils/click/getMouseEventOptions.js +0 -61
  113. package/dist/utils/edit/cursorPosition.d.ts +0 -2
  114. package/dist/utils/edit/cursorPosition.js +0 -35
  115. package/dist/utils/edit/hasUnreliableEmptyValue.d.ts +0 -10
  116. package/dist/utils/edit/hasUnreliableEmptyValue.js +0 -21
  117. package/dist/utils/edit/selectionRange.d.ts +0 -16
  118. package/dist/utils/edit/selectionRange.js +0 -104
  119. package/dist/utils/misc/isDocument.d.ts +0 -1
  120. package/dist/utils/misc/isDocument.js +0 -10
  121. package/dist/utils/misc/isLabelWithInternallyDisabledControl.d.ts +0 -1
  122. package/dist/utils/misc/isLabelWithInternallyDisabledControl.js +0 -22
@@ -0,0 +1,7 @@
1
+ import type { inputDeviceState, pointerKey, PointerTarget, SelectionTarget } from './types';
2
+ export interface PointerPressAction extends PointerTarget, SelectionTarget {
3
+ keyDef: pointerKey;
4
+ releasePrevious: boolean;
5
+ releaseSelf: boolean;
6
+ }
7
+ export declare function pointerPress(action: PointerPressAction, state: inputDeviceState): Promise<void>;
@@ -0,0 +1,330 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.pointerPress = pointerPress;
7
+
8
+ var _dom = require("@testing-library/dom");
9
+
10
+ var _utils = require("../utils");
11
+
12
+ var _document = require("../document");
13
+
14
+ var _resolveSelectionTarget = require("./resolveSelectionTarget");
15
+
16
+ /* eslint-disable complexity */
17
+ async function pointerPress(action, state) {
18
+ const {
19
+ keyDef,
20
+ target,
21
+ releasePrevious,
22
+ releaseSelf
23
+ } = action;
24
+ const previous = state.pointerState.pressed.find(p => p.keyDef === keyDef);
25
+ const pointerName = keyDef.pointerType === 'touch' ? keyDef.name : keyDef.pointerType;
26
+ const targetIsDisabled = (0, _utils.isDisabled)(target);
27
+
28
+ if (previous) {
29
+ up(state, pointerName, action, previous, targetIsDisabled);
30
+ }
31
+
32
+ if (!releasePrevious) {
33
+ const press = down(state, pointerName, action, targetIsDisabled);
34
+
35
+ if (releaseSelf) {
36
+ up(state, pointerName, action, press, targetIsDisabled);
37
+ }
38
+ }
39
+ }
40
+
41
+ function getNextPointerId(state) {
42
+ state.pointerId = state.pointerId + 1;
43
+ return state.pointerId;
44
+ }
45
+
46
+ function down({
47
+ pointerState,
48
+ keyboardState
49
+ }, pointerName, {
50
+ keyDef,
51
+ node,
52
+ offset,
53
+ target,
54
+ coords
55
+ }, targetIsDisabled) {
56
+ var _pointerState$activeC, _pointerState$activeC2, _pointerState$activeC3;
57
+
58
+ const {
59
+ name,
60
+ pointerType,
61
+ button
62
+ } = keyDef;
63
+ const pointerId = pointerType === 'mouse' ? 1 : getNextPointerId(pointerState);
64
+ pointerState.position[pointerName] = { ...pointerState.position[pointerName],
65
+ pointerId,
66
+ pointerType,
67
+ target,
68
+ coords
69
+ };
70
+ let isMultiTouch = false;
71
+ let isPrimary = true;
72
+
73
+ if (pointerType !== 'mouse') {
74
+ for (const obj of pointerState.pressed) {
75
+ // TODO: test multi device input across browsers
76
+ // istanbul ignore else
77
+ if (obj.keyDef.pointerType === pointerType) {
78
+ obj.isMultiTouch = true;
79
+ isMultiTouch = true;
80
+ isPrimary = false;
81
+ }
82
+ }
83
+ }
84
+
85
+ if (((_pointerState$activeC = pointerState.activeClickCount) == null ? void 0 : _pointerState$activeC[0]) !== name) {
86
+ delete pointerState.activeClickCount;
87
+ }
88
+
89
+ const clickCount = Number((_pointerState$activeC2 = (_pointerState$activeC3 = pointerState.activeClickCount) == null ? void 0 : _pointerState$activeC3[1]) != null ? _pointerState$activeC2 : 0) + 1;
90
+ pointerState.activeClickCount = [name, clickCount];
91
+ const pressObj = {
92
+ keyDef,
93
+ downTarget: target,
94
+ pointerId,
95
+ unpreventedDefault: true,
96
+ isMultiTouch,
97
+ isPrimary,
98
+ clickCount
99
+ };
100
+ pointerState.pressed.push(pressObj);
101
+
102
+ if (!targetIsDisabled) {
103
+ if (pointerType !== 'mouse') {
104
+ fire('pointerover');
105
+ fire('pointerenter');
106
+ }
107
+
108
+ if (pointerType !== 'mouse' || !pointerState.pressed.some(p => p.keyDef !== keyDef && p.keyDef.pointerType === pointerType)) {
109
+ fire('pointerdown');
110
+ }
111
+
112
+ if (pointerType === 'mouse') {
113
+ pressObj.unpreventedDefault = fire('mousedown');
114
+ } // TODO: touch...
115
+
116
+ }
117
+
118
+ if (pointerType === 'mouse' && pressObj.unpreventedDefault) {
119
+ mousedownDefaultBehavior({
120
+ target,
121
+ targetIsDisabled,
122
+ clickCount,
123
+ position: pointerState.position[pointerName],
124
+ node,
125
+ offset
126
+ });
127
+ }
128
+
129
+ return pressObj;
130
+
131
+ function fire(type) {
132
+ return (0, _utils.firePointerEvent)(target, type, {
133
+ pointerState,
134
+ keyboardState,
135
+ button,
136
+ clickCount,
137
+ coords,
138
+ isPrimary,
139
+ pointerId,
140
+ pointerType
141
+ });
142
+ }
143
+ }
144
+
145
+ function up({
146
+ pointerState,
147
+ keyboardState
148
+ }, pointerName, {
149
+ keyDef: {
150
+ pointerType,
151
+ button
152
+ },
153
+ target,
154
+ coords,
155
+ node,
156
+ offset
157
+ }, pressed, targetIsDisabled) {
158
+ pointerState.pressed = pointerState.pressed.filter(p => p !== pressed);
159
+ const {
160
+ isMultiTouch,
161
+ isPrimary,
162
+ pointerId,
163
+ clickCount
164
+ } = pressed;
165
+ let {
166
+ unpreventedDefault
167
+ } = pressed;
168
+ pointerState.position[pointerName] = { ...pointerState.position[pointerName],
169
+ target,
170
+ coords
171
+ }; // TODO: pointerleave for touch device
172
+
173
+ if (!targetIsDisabled) {
174
+ if (pointerType !== 'mouse' || !pointerState.pressed.filter(p => p.keyDef.pointerType === pointerType).length) {
175
+ fire('pointerup');
176
+ }
177
+
178
+ if (pointerType !== 'mouse') {
179
+ fire('pointerout');
180
+ fire('pointerleave');
181
+ }
182
+
183
+ if (pointerType !== 'mouse' && !isMultiTouch) {
184
+ if (clickCount === 1) {
185
+ fire('mouseover');
186
+ fire('mouseenter');
187
+ }
188
+
189
+ fire('mousemove');
190
+ unpreventedDefault = fire('mousedown') && unpreventedDefault;
191
+ }
192
+ }
193
+
194
+ if (unpreventedDefault && pointerType !== 'mouse' && !isMultiTouch) {
195
+ mousedownDefaultBehavior({
196
+ target,
197
+ targetIsDisabled,
198
+ clickCount,
199
+ position: pointerState.position[pointerName],
200
+ node,
201
+ offset
202
+ });
203
+ }
204
+
205
+ delete pointerState.position[pointerName].selectionRange;
206
+
207
+ if (!targetIsDisabled) {
208
+ if (pointerType === 'mouse' || !isMultiTouch) {
209
+ unpreventedDefault = fire('mouseup') && unpreventedDefault;
210
+ const canClick = pointerType !== 'mouse' || button === 'primary';
211
+
212
+ if (canClick && target === pressed.downTarget) {
213
+ fire('click');
214
+
215
+ if (clickCount === 2) {
216
+ fire('dblclick');
217
+ } // If the click happens inside a `label` with a control, the control (or closes focusable) is focused.
218
+
219
+
220
+ const label = target.closest('label');
221
+
222
+ if (label != null && label.control) {
223
+ var _findClosest;
224
+
225
+ (0, _utils.focus)((_findClosest = (0, _utils.findClosest)(label.control, _utils.isFocusable)) != null ? _findClosest : target.ownerDocument.body);
226
+ }
227
+ }
228
+
229
+ if (pointerType === 'mouse' && button === 'secondary') {
230
+ _dom.fireEvent.contextMenu(target);
231
+ }
232
+ }
233
+ }
234
+
235
+ function fire(type) {
236
+ return (0, _utils.firePointerEvent)(target, type, {
237
+ pointerState,
238
+ keyboardState,
239
+ button,
240
+ clickCount,
241
+ coords,
242
+ isPrimary,
243
+ pointerId,
244
+ pointerType
245
+ });
246
+ }
247
+ }
248
+
249
+ function mousedownDefaultBehavior({
250
+ position,
251
+ target,
252
+ targetIsDisabled,
253
+ clickCount,
254
+ node,
255
+ offset
256
+ }) {
257
+ var _findClosest2;
258
+
259
+ // The closest focusable element is focused when a `mousedown` would have been fired.
260
+ // Even if there was no `mousedown` because the element was disabled.
261
+ // A `mousedown` that preventsDefault cancels this though.
262
+ (0, _utils.focus)((_findClosest2 = (0, _utils.findClosest)(target, _utils.isFocusable)) != null ? _findClosest2 : target.ownerDocument.body); // TODO: What happens if a focus event handler interfers?
263
+ // An unprevented mousedown moves the cursor to the closest character.
264
+ // We try to approximate the behavior for a no-layout environment.
265
+
266
+ if (!targetIsDisabled) {
267
+ const hasValue = (0, _utils.isElementType)(target, ['input', 'textarea']); // On non-input elements the text selection per multiple click
268
+ // can extend beyond the target boundaries.
269
+ // The exact mechanism what is considered in the same line is unclear.
270
+ // Looks it might be every inline element.
271
+ // TODO: Check what might be considered part of the same line of text.
272
+
273
+ const text = String(hasValue ? (0, _document.getUIValue)(target) : target.textContent);
274
+ const [start, end] = node ? // As offset is describing a DOMOffset it is non-trivial to determine
275
+ // which elements might be considered in the same line of text.
276
+ // TODO: support expanding initial range on multiple clicks if node is given
277
+ [offset, offset] : getTextRange(text, offset, clickCount); // TODO: implement modifying selection per shift/ctrl+mouse
278
+
279
+ if (hasValue) {
280
+ (0, _document.setUISelection)(target, {
281
+ anchorOffset: start != null ? start : text.length,
282
+ focusOffset: end != null ? end : text.length
283
+ });
284
+ position.selectionRange = {
285
+ node: target,
286
+ start: start != null ? start : 0,
287
+ end: end != null ? end : text.length
288
+ };
289
+ } else {
290
+ const {
291
+ node: startNode,
292
+ offset: startOffset
293
+ } = (0, _resolveSelectionTarget.resolveSelectionTarget)({
294
+ target,
295
+ node,
296
+ offset: start
297
+ });
298
+ const {
299
+ node: endNode,
300
+ offset: endOffset
301
+ } = (0, _resolveSelectionTarget.resolveSelectionTarget)({
302
+ target,
303
+ node,
304
+ offset: end
305
+ });
306
+ const range = new Range();
307
+ range.setStart(startNode, startOffset);
308
+ range.setEnd(endNode, endOffset);
309
+ position.selectionRange = range;
310
+ const selection = target.ownerDocument.getSelection();
311
+ selection.removeAllRanges();
312
+ selection.addRange(range.cloneRange());
313
+ }
314
+ }
315
+ }
316
+
317
+ function getTextRange(text, pos, clickCount) {
318
+ if (clickCount % 3 === 1 || text.length === 0) {
319
+ return [pos, pos];
320
+ }
321
+
322
+ const textPos = pos != null ? pos : text.length;
323
+
324
+ if (clickCount % 3 === 2) {
325
+ return [textPos - text.substr(0, pos).match(/(\w+|\s+|\W)?$/)[0].length, pos === undefined ? pos : pos + text.substr(pos).match(/^(\w+|\s+|\W)?/)[0].length];
326
+ } // triple click
327
+
328
+
329
+ return [textPos - text.substr(0, pos).match(/[^\r\n]*$/)[0].length, pos === undefined ? pos : pos + text.substr(pos).match(/^[^\r\n]*/)[0].length];
330
+ }
@@ -0,0 +1,5 @@
1
+ import { PointerTarget, SelectionTarget } from './types';
2
+ export declare function resolveSelectionTarget({ target, node, offset, }: PointerTarget & SelectionTarget): {
3
+ node: Node;
4
+ offset: number;
5
+ };
@@ -0,0 +1,75 @@
1
+ "use strict";
2
+
3
+ Object.defineProperty(exports, "__esModule", {
4
+ value: true
5
+ });
6
+ exports.resolveSelectionTarget = resolveSelectionTarget;
7
+
8
+ var _document = require("../document");
9
+
10
+ var _utils = require("../utils");
11
+
12
+ function resolveSelectionTarget({
13
+ target,
14
+ node,
15
+ offset
16
+ }) {
17
+ if ((0, _utils.isElementType)(target, ['input', 'textarea'])) {
18
+ return {
19
+ node: target,
20
+ offset: offset != null ? offset : (0, _document.getUIValue)(target).length
21
+ };
22
+ } else if (node) {
23
+ return {
24
+ node,
25
+ offset: offset != null ? offset : node.nodeType === 3 ? node.nodeValue.length : node.childNodes.length
26
+ };
27
+ }
28
+
29
+ return findNodeAtTextOffset(target, offset);
30
+ }
31
+
32
+ function findNodeAtTextOffset(node, offset, isRoot = true) {
33
+ // When clicking after the content the browser behavior can be complicated:
34
+ // 1. If there is textContent after the last element child,
35
+ // the cursor is moved there.
36
+ // 2. If there is textContent in the last element child,
37
+ // the browser moves the cursor to the last non-empty text node inside this element.
38
+ // 3. Otherwise the cursor is moved to the end of the target.
39
+ let i = offset === undefined ? node.childNodes.length - 1 : 0;
40
+ const step = offset === undefined ? -1 : +1;
41
+
42
+ while (offset === undefined ? i >= (isRoot ? Math.max(node.childNodes.length - 1, 0) : 0) : i <= node.childNodes.length) {
43
+ const c = node.childNodes.item(i);
44
+ const text = String(c.textContent);
45
+
46
+ if (text.length) {
47
+ if (offset !== undefined && text.length < offset) {
48
+ offset -= text.length;
49
+ } else if (c.nodeType === 1) {
50
+ return findNodeAtTextOffset(c, offset, false);
51
+ } else {
52
+ // The pre-commit hooks keeps changing this
53
+ // See https://github.com/kentcdodds/kcd-scripts/issues/218
54
+
55
+ /* istanbul ignore else */
56
+ // eslint-disable-next-line no-lonely-if
57
+ if (c.nodeType === 3) {
58
+ var _offset;
59
+
60
+ return {
61
+ node: c,
62
+ offset: (_offset = offset) != null ? _offset : c.nodeValue.length
63
+ };
64
+ }
65
+ }
66
+ }
67
+
68
+ i += step;
69
+ }
70
+
71
+ return {
72
+ node,
73
+ offset: node.childNodes.length
74
+ };
75
+ }
@@ -0,0 +1,72 @@
1
+ import { keyboardState } from '../keyboard/types';
2
+ import { PointerCoords, MouseButton } from '../utils';
3
+ /**
4
+ * @internal Do not create/alter this by yourself as this type might be subject to changes.
5
+ */
6
+ export declare type pointerState = {
7
+ /**
8
+ All keys that have been pressed and not been lifted up yet.
9
+ */
10
+ pressed: {
11
+ keyDef: pointerKey;
12
+ pointerId: number;
13
+ isMultiTouch: boolean;
14
+ isPrimary: boolean;
15
+ clickCount: number;
16
+ unpreventedDefault: boolean;
17
+ /** Target the key was pressed on */
18
+ downTarget: Element;
19
+ }[];
20
+ activeClickCount?: [string, number];
21
+ /**
22
+ * Position of each pointer.
23
+ * The mouse is always pointer 1 and keeps its position.
24
+ * Pen and touch devices receive a new pointerId for every interaction.
25
+ */
26
+ position: Record<string, {
27
+ pointerId: number;
28
+ pointerType: 'mouse' | 'pen' | 'touch';
29
+ } & Partial<PointerTarget> & {
30
+ selectionRange?: Range | SelectionInputRange;
31
+ }>;
32
+ /**
33
+ * Last applied pointer id
34
+ */
35
+ pointerId: number;
36
+ };
37
+ export declare type pointerOptions = {
38
+ /** Delay between keystrokes */
39
+ delay: number;
40
+ /** Available pointer keys */
41
+ pointerMap: pointerKey[];
42
+ };
43
+ export interface pointerKey {
44
+ /** Name of the pointer key */
45
+ name: string;
46
+ /** Type of the pointer device */
47
+ pointerType: 'mouse' | 'pen' | 'touch';
48
+ /** Type of button */
49
+ button?: MouseButton;
50
+ }
51
+ export interface PointerTarget {
52
+ target: Element;
53
+ coords?: PointerCoords;
54
+ }
55
+ export interface SelectionTarget {
56
+ node?: Node;
57
+ /**
58
+ * If `node` is set, this is the DOM offset.
59
+ * Otherwise this is the `textContent`/`value` offset on the `target`.
60
+ */
61
+ offset?: number;
62
+ }
63
+ /** Describes a selection inside `HTMLInputElement`/`HTMLTextareaElement` */
64
+ export interface SelectionInputRange {
65
+ node: HTMLInputElement | HTMLTextAreaElement;
66
+ start: number;
67
+ end: number;
68
+ }
69
+ export interface inputDeviceState {
70
+ pointerState: pointerState;
71
+ keyboardState: keyboardState;
72
+ }
@@ -0,0 +1 @@
1
+ "use strict";
@@ -0,0 +1,4 @@
1
+ import { PointerOptions } from './utils';
2
+ import type { UserEvent } from './setup';
3
+ export declare function selectOptions(this: UserEvent, select: Element, values: HTMLElement | HTMLElement[] | string[] | string, init?: MouseEventInit, options?: PointerOptions): void;
4
+ export declare function deselectOptions(this: UserEvent, select: Element, values: HTMLElement | HTMLElement[] | string[] | string, init?: MouseEventInit, options?: PointerOptions): void;
@@ -3,21 +3,24 @@
3
3
  Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
- exports.selectOptions = exports.deselectOptions = void 0;
6
+ exports.deselectOptions = deselectOptions;
7
+ exports.selectOptions = selectOptions;
7
8
 
8
9
  var _dom = require("@testing-library/dom");
9
10
 
10
11
  var _utils = require("./utils");
11
12
 
12
- var _click = require("./click");
13
-
14
- var _focus = require("./focus");
13
+ function selectOptions(select, values, init, options = {}) {
14
+ return selectOptionsBase.call(this, true, select, values, init, options);
15
+ }
15
16
 
16
- var _hover = require("./hover");
17
+ function deselectOptions(select, values, init, options = {}) {
18
+ return selectOptionsBase.call(this, false, select, values, init, options);
19
+ }
17
20
 
18
21
  function selectOptionsBase(newValue, select, values, init, {
19
- skipPointerEventsCheck = false
20
- } = {}) {
22
+ skipPointerEventsCheck
23
+ }) {
21
24
  if (!newValue && !select.multiple) {
22
25
  throw (0, _dom.getConfig)().getElementError(`Unable to deselect an option in a non-multiple select. Use selectOptions to change the selection instead.`, select);
23
26
  }
@@ -62,7 +65,7 @@ function selectOptionsBase(newValue, select, values, init, {
62
65
  _dom.fireEvent.mouseDown(option, init);
63
66
  }
64
67
 
65
- (0, _focus.focus)(select);
68
+ (0, _utils.focus)(select);
66
69
 
67
70
  if (withPointerEvents) {
68
71
  _dom.fireEvent.pointerUp(option, init);
@@ -80,11 +83,11 @@ function selectOptionsBase(newValue, select, values, init, {
80
83
  const withPointerEvents = skipPointerEventsCheck ? true : (0, _utils.hasPointerEvents)(select); // the click to open the select options
81
84
 
82
85
  if (withPointerEvents) {
83
- (0, _click.click)(select, init, {
84
- skipPointerEventsCheck
86
+ this.click(select, init, {
87
+ skipPointerEventsCheck: true
85
88
  });
86
89
  } else {
87
- (0, _focus.focus)(select);
90
+ (0, _utils.focus)(select);
88
91
  }
89
92
 
90
93
  selectOption(selectedOptions[0]);
@@ -111,13 +114,13 @@ function selectOptionsBase(newValue, select, values, init, {
111
114
  }
112
115
  } else if (select.getAttribute('role') === 'listbox') {
113
116
  selectedOptions.forEach(option => {
114
- (0, _hover.hover)(option, init, {
117
+ this.hover(option, init, {
115
118
  skipPointerEventsCheck
116
119
  });
117
- (0, _click.click)(option, init, {
120
+ this.click(option, init, {
118
121
  skipPointerEventsCheck
119
122
  });
120
- (0, _hover.unhover)(option, init, {
123
+ this.unhover(option, init, {
121
124
  skipPointerEventsCheck
122
125
  });
123
126
  });
@@ -136,9 +139,4 @@ function selectOptionsBase(newValue, select, values, init, {
136
139
 
137
140
  _dom.fireEvent.change(select, init);
138
141
  }
139
- }
140
-
141
- const selectOptions = selectOptionsBase.bind(null, true);
142
- exports.selectOptions = selectOptions;
143
- const deselectOptions = selectOptionsBase.bind(null, false);
144
- exports.deselectOptions = deselectOptions;
142
+ }
@@ -0,0 +1,92 @@
1
+ import { clear } from './clear';
2
+ import { click, clickOptions, dblClick, tripleClick } from './click';
3
+ import { hover, unhover } from './hover';
4
+ import { keyboard, keyboardOptions } from './keyboard';
5
+ import type { keyboardState } from './keyboard/types';
6
+ import { paste } from './paste';
7
+ import { pointer } from './pointer';
8
+ import type { pointerOptions, pointerState } from './pointer/types';
9
+ import { deselectOptions, selectOptions } from './selectOptions';
10
+ import { tab, tabOptions } from './tab';
11
+ import { type, typeOptions } from './type';
12
+ import { upload, uploadOptions } from './upload';
13
+ import { PointerOptions } from './utils';
14
+ export declare const userEventApis: {
15
+ clear: typeof clear;
16
+ click: typeof click;
17
+ dblClick: typeof dblClick;
18
+ deselectOptions: typeof deselectOptions;
19
+ hover: typeof hover;
20
+ keyboard: typeof keyboard;
21
+ paste: typeof paste;
22
+ pointer: typeof pointer;
23
+ selectOptions: typeof selectOptions;
24
+ tab: typeof tab;
25
+ tripleClick: typeof tripleClick;
26
+ type: typeof type;
27
+ unhover: typeof unhover;
28
+ upload: typeof upload;
29
+ };
30
+ export declare type UserEventApis = typeof userEventApis;
31
+ declare type setup = ReturnType<typeof _setup>['setup'];
32
+ export declare type UserEvent = UserEventApis & {
33
+ setup: setup;
34
+ };
35
+ declare type ClickOptions = Omit<clickOptions, 'clickCount'>;
36
+ declare type KeyboardOptions = Partial<keyboardOptions>;
37
+ declare type PointerApiOptions = Partial<pointerOptions>;
38
+ declare type TabOptions = Omit<tabOptions, 'shift'>;
39
+ declare type TypeOptions = Omit<typeOptions, 'initialSelectionStart' | 'initialSelectionEnd'>;
40
+ declare type UploadOptions = uploadOptions;
41
+ interface SetupOptions extends ClickOptions, KeyboardOptions, PointerOptions, PointerApiOptions, TabOptions, TypeOptions, UploadOptions {
42
+ }
43
+ /**
44
+ * Start a "session" with userEvent.
45
+ * All APIs returned by this function share an input device state and a default configuration.
46
+ */
47
+ export declare function setup(options?: SetupOptions): {
48
+ clear: typeof clear;
49
+ click: typeof click;
50
+ dblClick: typeof dblClick;
51
+ deselectOptions: typeof deselectOptions;
52
+ hover: typeof hover;
53
+ keyboard: typeof keyboard;
54
+ paste: typeof paste;
55
+ pointer: typeof pointer;
56
+ selectOptions: typeof selectOptions;
57
+ tab: typeof tab;
58
+ tripleClick: typeof tripleClick;
59
+ type: typeof type;
60
+ unhover: typeof unhover;
61
+ upload: typeof upload;
62
+ } & {
63
+ /**
64
+ * Create a set of callbacks with different default settings but the same state.
65
+ */
66
+ setup(options: SetupOptions): {
67
+ clear: typeof clear;
68
+ click: typeof click;
69
+ dblClick: typeof dblClick;
70
+ deselectOptions: typeof deselectOptions;
71
+ hover: typeof hover;
72
+ keyboard: typeof keyboard;
73
+ paste: typeof paste;
74
+ pointer: typeof pointer;
75
+ selectOptions: typeof selectOptions;
76
+ tab: typeof tab;
77
+ tripleClick: typeof tripleClick;
78
+ type: typeof type;
79
+ unhover: typeof unhover;
80
+ upload: typeof upload;
81
+ } & any;
82
+ };
83
+ declare function _setup({ applyAccept, autoModify, delay, document, keyboardMap, pointerMap, skipAutoClose, skipClick, skipHover, skipPointerEventsCheck, }: SetupOptions, { keyboardState, pointerState, }: {
84
+ keyboardState: keyboardState;
85
+ pointerState: pointerState;
86
+ }): UserEventApis & {
87
+ /**
88
+ * Create a set of callbacks with different default settings but the same state.
89
+ */
90
+ setup(options: SetupOptions): ReturnType<typeof _setup>;
91
+ };
92
+ export {};