@testing-library/user-event 10.3.2 → 10.4.0
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.
- package/CHANGELOG.md +5 -0
- package/LICENSE +2 -3
- package/README.md +201 -107
- package/dist/index.js +326 -252
- package/package.json +42 -43
- package/typings/index.d.ts +24 -20
- package/.all-contributorsrc +0 -311
- package/.babelrc +0 -13
- package/.gitattributes +0 -1
- package/.nvmrc +0 -1
- package/.prettierrc.js +0 -3
- package/.travis.yml +0 -30
- package/__tests__/react/clear.js +0 -94
- package/__tests__/react/click.js +0 -437
- package/__tests__/react/dblclick.js +0 -211
- package/__tests__/react/selectoptions.js +0 -282
- package/__tests__/react/tab.js +0 -277
- package/__tests__/react/type.js +0 -265
- package/__tests__/react/upload.js +0 -124
- package/__tests__/vue/click.js +0 -342
- package/__tests__/vue/dblclick.js +0 -126
- package/__tests__/vue/selectoptions.js +0 -254
- package/__tests__/vue/type.js +0 -240
- package/lint-staged.config.js +0 -21
- package/other/dog.png +0 -0
- package/src/index.js +0 -373
package/src/index.js
DELETED
|
@@ -1,373 +0,0 @@
|
|
|
1
|
-
import { fireEvent } from "@testing-library/dom";
|
|
2
|
-
|
|
3
|
-
function wait(time) {
|
|
4
|
-
return new Promise(function (resolve) {
|
|
5
|
-
setTimeout(() => resolve(), time);
|
|
6
|
-
});
|
|
7
|
-
}
|
|
8
|
-
|
|
9
|
-
function findTagInParents(element, tagName) {
|
|
10
|
-
if (element.parentNode == null) return undefined;
|
|
11
|
-
if (element.parentNode.tagName === tagName) return element.parentNode;
|
|
12
|
-
return findTagInParents(element.parentNode, tagName);
|
|
13
|
-
}
|
|
14
|
-
|
|
15
|
-
function clickLabel(label) {
|
|
16
|
-
fireEvent.mouseOver(label);
|
|
17
|
-
fireEvent.mouseMove(label);
|
|
18
|
-
fireEvent.mouseDown(label);
|
|
19
|
-
fireEvent.mouseUp(label);
|
|
20
|
-
|
|
21
|
-
if (label.htmlFor) {
|
|
22
|
-
const input = document.getElementById(label.htmlFor);
|
|
23
|
-
input.focus();
|
|
24
|
-
fireEvent.click(label);
|
|
25
|
-
} else {
|
|
26
|
-
const input = label.querySelector("input,textarea,select");
|
|
27
|
-
input.focus();
|
|
28
|
-
label.focus();
|
|
29
|
-
fireEvent.click(label);
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
function clickBooleanElement(element) {
|
|
34
|
-
if (element.disabled) return;
|
|
35
|
-
|
|
36
|
-
fireEvent.mouseOver(element);
|
|
37
|
-
fireEvent.mouseMove(element);
|
|
38
|
-
fireEvent.mouseDown(element);
|
|
39
|
-
fireEvent.focus(element);
|
|
40
|
-
fireEvent.mouseUp(element);
|
|
41
|
-
fireEvent.click(element);
|
|
42
|
-
}
|
|
43
|
-
|
|
44
|
-
function clickElement(element, previousElement, init) {
|
|
45
|
-
fireEvent.mouseOver(element);
|
|
46
|
-
fireEvent.mouseMove(element);
|
|
47
|
-
const wasAnotherElementFocused =
|
|
48
|
-
previousElement !== element.ownerDocument.body &&
|
|
49
|
-
previousElement !== element;
|
|
50
|
-
const continueDefaultHandling = fireEvent.mouseDown(element);
|
|
51
|
-
if (continueDefaultHandling) {
|
|
52
|
-
wasAnotherElementFocused && previousElement.blur();
|
|
53
|
-
previousElement !== element && element.focus();
|
|
54
|
-
}
|
|
55
|
-
fireEvent.mouseUp(element);
|
|
56
|
-
fireEvent.click(element, init);
|
|
57
|
-
|
|
58
|
-
const labelAncestor = findTagInParents(element, "LABEL");
|
|
59
|
-
labelAncestor && clickLabel(labelAncestor);
|
|
60
|
-
}
|
|
61
|
-
|
|
62
|
-
function dblClickElement(element, previousElement) {
|
|
63
|
-
fireEvent.mouseOver(element);
|
|
64
|
-
fireEvent.mouseMove(element);
|
|
65
|
-
const wasAnotherElementFocused =
|
|
66
|
-
previousElement !== element.ownerDocument.body &&
|
|
67
|
-
previousElement !== element;
|
|
68
|
-
const continueDefaultHandling = fireEvent.mouseDown(element);
|
|
69
|
-
if (continueDefaultHandling) {
|
|
70
|
-
wasAnotherElementFocused && previousElement.blur();
|
|
71
|
-
previousElement !== element && element.focus();
|
|
72
|
-
}
|
|
73
|
-
fireEvent.mouseUp(element);
|
|
74
|
-
fireEvent.click(element);
|
|
75
|
-
fireEvent.mouseDown(element);
|
|
76
|
-
fireEvent.mouseUp(element);
|
|
77
|
-
fireEvent.click(element);
|
|
78
|
-
fireEvent.dblClick(element);
|
|
79
|
-
|
|
80
|
-
const labelAncestor = findTagInParents(element, "LABEL");
|
|
81
|
-
labelAncestor && clickLabel(labelAncestor);
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
function dblClickCheckbox(checkbox) {
|
|
85
|
-
fireEvent.mouseOver(checkbox);
|
|
86
|
-
fireEvent.mouseMove(checkbox);
|
|
87
|
-
fireEvent.mouseDown(checkbox);
|
|
88
|
-
fireEvent.focus(checkbox);
|
|
89
|
-
fireEvent.mouseUp(checkbox);
|
|
90
|
-
fireEvent.click(checkbox);
|
|
91
|
-
fireEvent.mouseDown(checkbox);
|
|
92
|
-
fireEvent.mouseUp(checkbox);
|
|
93
|
-
fireEvent.click(checkbox);
|
|
94
|
-
}
|
|
95
|
-
|
|
96
|
-
function selectOption(select, option) {
|
|
97
|
-
fireEvent.mouseOver(option);
|
|
98
|
-
fireEvent.mouseMove(option);
|
|
99
|
-
fireEvent.mouseDown(option);
|
|
100
|
-
fireEvent.focus(option);
|
|
101
|
-
fireEvent.mouseUp(option);
|
|
102
|
-
fireEvent.click(option);
|
|
103
|
-
|
|
104
|
-
option.selected = true;
|
|
105
|
-
|
|
106
|
-
fireEvent.change(select);
|
|
107
|
-
}
|
|
108
|
-
|
|
109
|
-
function fireChangeEvent(event) {
|
|
110
|
-
fireEvent.change(event.target);
|
|
111
|
-
event.target.removeEventListener("blur", fireChangeEvent);
|
|
112
|
-
}
|
|
113
|
-
|
|
114
|
-
const Keys = {
|
|
115
|
-
Backspace: { keyCode: 8, code: "Backspace", key: "Backspace" },
|
|
116
|
-
};
|
|
117
|
-
|
|
118
|
-
function backspace(element) {
|
|
119
|
-
const eventOptions = {
|
|
120
|
-
key: Keys.Backspace.key,
|
|
121
|
-
keyCode: Keys.Backspace.keyCode,
|
|
122
|
-
which: Keys.Backspace.keyCode,
|
|
123
|
-
};
|
|
124
|
-
fireEvent.keyDown(element, eventOptions);
|
|
125
|
-
fireEvent.keyUp(element, eventOptions);
|
|
126
|
-
|
|
127
|
-
if (!element.readOnly) {
|
|
128
|
-
fireEvent.input(element, {
|
|
129
|
-
inputType: "deleteContentBackward",
|
|
130
|
-
});
|
|
131
|
-
element.value = ""; // when we add special keys to API, will need to respect selected range
|
|
132
|
-
}
|
|
133
|
-
}
|
|
134
|
-
|
|
135
|
-
function selectAll(element) {
|
|
136
|
-
userEvent.dblClick(element); // simulate events (will not actually select)
|
|
137
|
-
const elementType = element.type;
|
|
138
|
-
// type is a readonly property on textarea, so check if element is an input before trying to modify it
|
|
139
|
-
if (isInputElement(element)) {
|
|
140
|
-
// setSelectionRange is not supported on certain types of inputs, e.g. "number" or "email"
|
|
141
|
-
element.type = "text";
|
|
142
|
-
}
|
|
143
|
-
element.setSelectionRange(0, element.value.length);
|
|
144
|
-
if (isInputElement(element)) {
|
|
145
|
-
element.type = elementType;
|
|
146
|
-
}
|
|
147
|
-
}
|
|
148
|
-
|
|
149
|
-
function isInputElement(element) {
|
|
150
|
-
return element.tagName.toLowerCase() === "input";
|
|
151
|
-
}
|
|
152
|
-
|
|
153
|
-
const userEvent = {
|
|
154
|
-
click(element, init) {
|
|
155
|
-
const focusedElement = element.ownerDocument.activeElement;
|
|
156
|
-
const wasAnotherElementFocused =
|
|
157
|
-
focusedElement !== element.ownerDocument.body &&
|
|
158
|
-
focusedElement !== element;
|
|
159
|
-
if (wasAnotherElementFocused) {
|
|
160
|
-
fireEvent.mouseMove(focusedElement);
|
|
161
|
-
fireEvent.mouseLeave(focusedElement);
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
switch (element.tagName) {
|
|
165
|
-
case "LABEL":
|
|
166
|
-
clickLabel(element);
|
|
167
|
-
break;
|
|
168
|
-
case "INPUT":
|
|
169
|
-
if (element.type === "checkbox" || element.type === "radio") {
|
|
170
|
-
clickBooleanElement(element);
|
|
171
|
-
break;
|
|
172
|
-
}
|
|
173
|
-
default:
|
|
174
|
-
clickElement(element, focusedElement, init);
|
|
175
|
-
}
|
|
176
|
-
},
|
|
177
|
-
|
|
178
|
-
dblClick(element) {
|
|
179
|
-
const focusedElement = document.activeElement;
|
|
180
|
-
const wasAnotherElementFocused =
|
|
181
|
-
focusedElement !== document.body && focusedElement !== element;
|
|
182
|
-
if (wasAnotherElementFocused) {
|
|
183
|
-
fireEvent.mouseMove(focusedElement);
|
|
184
|
-
fireEvent.mouseLeave(focusedElement);
|
|
185
|
-
}
|
|
186
|
-
|
|
187
|
-
switch (element.tagName) {
|
|
188
|
-
case "INPUT":
|
|
189
|
-
if (element.type === "checkbox") {
|
|
190
|
-
dblClickCheckbox(element, wasAnotherElementFocused && focusedElement);
|
|
191
|
-
break;
|
|
192
|
-
}
|
|
193
|
-
default:
|
|
194
|
-
dblClickElement(element, focusedElement);
|
|
195
|
-
}
|
|
196
|
-
},
|
|
197
|
-
|
|
198
|
-
selectOptions(element, values) {
|
|
199
|
-
const focusedElement = document.activeElement;
|
|
200
|
-
const wasAnotherElementFocused =
|
|
201
|
-
focusedElement !== document.body && focusedElement !== element;
|
|
202
|
-
if (wasAnotherElementFocused) {
|
|
203
|
-
fireEvent.mouseMove(focusedElement);
|
|
204
|
-
fireEvent.mouseLeave(focusedElement);
|
|
205
|
-
}
|
|
206
|
-
|
|
207
|
-
clickElement(element, focusedElement);
|
|
208
|
-
|
|
209
|
-
const valArray = Array.isArray(values) ? values : [values];
|
|
210
|
-
const selectedOptions = Array.from(
|
|
211
|
-
element.querySelectorAll("option")
|
|
212
|
-
).filter((opt) => valArray.includes(opt.value));
|
|
213
|
-
|
|
214
|
-
if (selectedOptions.length > 0) {
|
|
215
|
-
if (element.multiple) {
|
|
216
|
-
selectedOptions.forEach((option) => selectOption(element, option));
|
|
217
|
-
} else {
|
|
218
|
-
selectOption(element, selectedOptions[0]);
|
|
219
|
-
}
|
|
220
|
-
}
|
|
221
|
-
},
|
|
222
|
-
|
|
223
|
-
clear(element) {
|
|
224
|
-
if (element.disabled) return;
|
|
225
|
-
|
|
226
|
-
selectAll(element);
|
|
227
|
-
backspace(element);
|
|
228
|
-
element.addEventListener("blur", fireChangeEvent);
|
|
229
|
-
},
|
|
230
|
-
|
|
231
|
-
async type(element, text, userOpts = {}) {
|
|
232
|
-
if (element.disabled) return;
|
|
233
|
-
const defaultOpts = {
|
|
234
|
-
allAtOnce: false,
|
|
235
|
-
delay: 0,
|
|
236
|
-
};
|
|
237
|
-
const opts = Object.assign(defaultOpts, userOpts);
|
|
238
|
-
|
|
239
|
-
const previousText = element.value;
|
|
240
|
-
|
|
241
|
-
const computedText =
|
|
242
|
-
element.maxLength > 0
|
|
243
|
-
? text.slice(0, Math.max(element.maxLength - previousText.length, 0))
|
|
244
|
-
: text;
|
|
245
|
-
|
|
246
|
-
if (opts.allAtOnce) {
|
|
247
|
-
if (element.readOnly) return;
|
|
248
|
-
fireEvent.input(element, {
|
|
249
|
-
target: { value: previousText + computedText },
|
|
250
|
-
});
|
|
251
|
-
} else {
|
|
252
|
-
let actuallyTyped = previousText;
|
|
253
|
-
for (let index = 0; index < text.length; index++) {
|
|
254
|
-
const char = text[index];
|
|
255
|
-
const key = char; // TODO: check if this also valid for characters with diacritic markers e.g. úé etc
|
|
256
|
-
const keyCode = char.charCodeAt(0);
|
|
257
|
-
|
|
258
|
-
if (opts.delay > 0) await wait(opts.delay);
|
|
259
|
-
|
|
260
|
-
const downEvent = fireEvent.keyDown(element, {
|
|
261
|
-
key: key,
|
|
262
|
-
keyCode: keyCode,
|
|
263
|
-
which: keyCode,
|
|
264
|
-
});
|
|
265
|
-
|
|
266
|
-
if (downEvent) {
|
|
267
|
-
const pressEvent = fireEvent.keyPress(element, {
|
|
268
|
-
key: key,
|
|
269
|
-
keyCode,
|
|
270
|
-
charCode: keyCode,
|
|
271
|
-
});
|
|
272
|
-
|
|
273
|
-
const isTextPastThreshold =
|
|
274
|
-
(actuallyTyped + key).length > (previousText + computedText).length;
|
|
275
|
-
|
|
276
|
-
if (pressEvent && !isTextPastThreshold) {
|
|
277
|
-
actuallyTyped += key;
|
|
278
|
-
if (!element.readOnly)
|
|
279
|
-
fireEvent.input(element, {
|
|
280
|
-
target: {
|
|
281
|
-
value: actuallyTyped,
|
|
282
|
-
},
|
|
283
|
-
bubbles: true,
|
|
284
|
-
cancelable: true,
|
|
285
|
-
});
|
|
286
|
-
}
|
|
287
|
-
}
|
|
288
|
-
|
|
289
|
-
fireEvent.keyUp(element, {
|
|
290
|
-
key: key,
|
|
291
|
-
keyCode: keyCode,
|
|
292
|
-
which: keyCode,
|
|
293
|
-
});
|
|
294
|
-
}
|
|
295
|
-
}
|
|
296
|
-
element.addEventListener("blur", fireChangeEvent);
|
|
297
|
-
},
|
|
298
|
-
|
|
299
|
-
upload(element, fileOrFiles, { clickInit, changeInit } = {}) {
|
|
300
|
-
if (element.disabled) return;
|
|
301
|
-
const focusedElement = element.ownerDocument.activeElement;
|
|
302
|
-
|
|
303
|
-
let files;
|
|
304
|
-
|
|
305
|
-
if (element.tagName === "LABEL") {
|
|
306
|
-
clickLabel(element);
|
|
307
|
-
const inputElement = element.htmlFor
|
|
308
|
-
? document.getElementById(element.htmlFor)
|
|
309
|
-
: querySelector("input");
|
|
310
|
-
files = inputElement.multiple ? fileOrFiles : [fileOrFiles];
|
|
311
|
-
} else {
|
|
312
|
-
files = element.multiple ? fileOrFiles : [fileOrFiles];
|
|
313
|
-
clickElement(element, focusedElement, clickInit);
|
|
314
|
-
}
|
|
315
|
-
|
|
316
|
-
fireEvent.change(element, {
|
|
317
|
-
target: {
|
|
318
|
-
files: {
|
|
319
|
-
length: files.length,
|
|
320
|
-
item: (index) => files[index] || null,
|
|
321
|
-
...files,
|
|
322
|
-
},
|
|
323
|
-
},
|
|
324
|
-
...changeInit,
|
|
325
|
-
});
|
|
326
|
-
},
|
|
327
|
-
|
|
328
|
-
tab({ shift = false, focusTrap = document } = {}) {
|
|
329
|
-
const focusableElements = focusTrap.querySelectorAll(
|
|
330
|
-
"input, button, select, textarea, a[href], [tabindex]"
|
|
331
|
-
);
|
|
332
|
-
|
|
333
|
-
const enabledElements = Array.prototype.filter.call(
|
|
334
|
-
focusableElements,
|
|
335
|
-
function (el) {
|
|
336
|
-
return el.getAttribute("tabindex") !== "-1" && !el.disabled;
|
|
337
|
-
}
|
|
338
|
-
);
|
|
339
|
-
|
|
340
|
-
if (enabledElements.length === 0) return;
|
|
341
|
-
|
|
342
|
-
const orderedElements = enabledElements
|
|
343
|
-
.map((el, idx) => ({ el, idx }))
|
|
344
|
-
.sort((a, b) => {
|
|
345
|
-
const tabIndexA = a.el.getAttribute("tabindex");
|
|
346
|
-
const tabIndexB = b.el.getAttribute("tabindex");
|
|
347
|
-
|
|
348
|
-
const diff = tabIndexA - tabIndexB;
|
|
349
|
-
|
|
350
|
-
return diff !== 0 ? diff : a.idx - b.idx;
|
|
351
|
-
});
|
|
352
|
-
|
|
353
|
-
const index = orderedElements.findIndex(
|
|
354
|
-
({ el }) => el === document.activeElement
|
|
355
|
-
);
|
|
356
|
-
|
|
357
|
-
let nextIndex = shift ? index - 1 : index + 1;
|
|
358
|
-
let defaultIndex = shift ? orderedElements.length - 1 : 0;
|
|
359
|
-
|
|
360
|
-
const { el: next } =
|
|
361
|
-
orderedElements[nextIndex] || orderedElements[defaultIndex];
|
|
362
|
-
|
|
363
|
-
if (next.getAttribute("tabindex") === null) {
|
|
364
|
-
next.setAttribute("tabindex", "0"); // jsdom requires tabIndex=0 for an item to become 'document.activeElement' (the browser does not)
|
|
365
|
-
next.focus();
|
|
366
|
-
next.removeAttribute("tabindex"); // leave no trace. :)
|
|
367
|
-
} else {
|
|
368
|
-
next.focus();
|
|
369
|
-
}
|
|
370
|
-
},
|
|
371
|
-
};
|
|
372
|
-
|
|
373
|
-
export default userEvent;
|