@testing-library/user-event 14.0.0-alpha.6 → 14.0.0-beta.1
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/dist/clipboard/copy.d.ts +2 -0
- package/dist/clipboard/copy.js +36 -0
- package/dist/clipboard/cut.d.ts +2 -0
- package/dist/clipboard/cut.js +42 -0
- package/dist/clipboard/index.d.ts +3 -0
- package/dist/clipboard/index.js +44 -0
- package/dist/clipboard/paste.d.ts +2 -0
- package/dist/clipboard/paste.js +47 -0
- package/dist/convenience/click.d.ts +4 -0
- package/dist/convenience/click.js +52 -0
- package/dist/convenience/hover.d.ts +3 -0
- package/dist/convenience/hover.js +31 -0
- package/dist/convenience/index.d.ts +3 -0
- package/dist/convenience/index.js +44 -0
- package/dist/convenience/tab.d.ts +4 -0
- package/dist/convenience/tab.js +12 -0
- package/dist/document/index.d.ts +1 -0
- package/dist/document/selection.d.ts +17 -7
- package/dist/document/selection.js +33 -17
- package/dist/document/value.d.ts +1 -1
- package/dist/document/value.js +1 -1
- package/dist/index.d.ts +2 -7
- package/dist/index.js +3 -12
- package/dist/keyboard/getEventProps.d.ts +0 -2
- package/dist/keyboard/getEventProps.js +1 -7
- package/dist/keyboard/index.d.ts +6 -18
- package/dist/keyboard/index.js +9 -45
- package/dist/keyboard/keyMap.js +24 -48
- package/dist/keyboard/keyboardAction.d.ts +10 -0
- package/dist/keyboard/keyboardAction.js +156 -0
- package/dist/keyboard/{getNextKeyDef.d.ts → parseKeyDef.d.ts} +4 -6
- package/dist/keyboard/parseKeyDef.js +61 -0
- package/dist/keyboard/plugins/arrow.js +7 -12
- package/dist/keyboard/plugins/character.js +42 -54
- package/dist/keyboard/plugins/combination.d.ts +5 -0
- package/dist/keyboard/plugins/combination.js +19 -0
- package/dist/keyboard/plugins/control.js +4 -12
- package/dist/keyboard/plugins/functional.js +46 -33
- package/dist/keyboard/plugins/index.d.ts +0 -1
- package/dist/keyboard/plugins/index.js +4 -11
- package/dist/keyboard/types.d.ts +3 -19
- package/dist/options.d.ts +102 -0
- package/dist/options.js +36 -0
- package/dist/pointer/index.d.ts +6 -14
- package/dist/pointer/index.js +8 -42
- package/dist/pointer/parseKeyDef.d.ts +2 -2
- package/dist/pointer/parseKeyDef.js +1 -3
- package/dist/pointer/pointerAction.d.ts +3 -2
- package/dist/pointer/pointerAction.js +9 -15
- package/dist/pointer/pointerMove.d.ts +2 -1
- package/dist/pointer/pointerMove.js +28 -17
- package/dist/pointer/pointerPress.d.ts +2 -1
- package/dist/pointer/pointerPress.js +6 -4
- package/dist/pointer/resolveSelectionTarget.js +7 -6
- package/dist/pointer/types.d.ts +0 -11
- package/dist/setup/api.d.ts +5 -0
- package/dist/setup/api.js +111 -0
- package/dist/setup/config.d.ts +10 -0
- package/dist/setup/config.js +8 -0
- package/dist/setup/directApi.d.ts +20 -0
- package/dist/setup/directApi.js +95 -0
- package/dist/setup/index.d.ts +30 -0
- package/dist/setup/index.js +27 -0
- package/dist/setup/setup.d.ts +74 -0
- package/dist/setup/setup.js +98 -0
- package/dist/setup/wrapAsync.d.ts +4 -0
- package/dist/setup/wrapAsync.js +15 -0
- package/dist/{clear.d.ts → utility/clear.d.ts} +2 -2
- package/dist/utility/clear.js +30 -0
- package/dist/utility/index.d.ts +4 -0
- package/dist/utility/index.js +57 -0
- package/dist/utility/selectOptions.d.ts +3 -0
- package/dist/{selectOptions.js → utility/selectOptions.js} +31 -41
- package/dist/utility/type.d.ts +9 -0
- package/dist/utility/type.js +37 -0
- package/dist/utility/upload.d.ts +5 -0
- package/dist/{upload.js → utility/upload.js} +12 -40
- package/dist/utils/dataTransfer/Blob.d.ts +1 -0
- package/dist/utils/dataTransfer/Blob.js +21 -0
- package/dist/utils/dataTransfer/Clipboard.d.ts +9 -0
- package/dist/utils/dataTransfer/Clipboard.js +188 -0
- package/dist/utils/dataTransfer/DataTransfer.d.ts +2 -0
- package/dist/utils/dataTransfer/DataTransfer.js +158 -0
- package/dist/utils/dataTransfer/FileList.d.ts +1 -0
- package/dist/utils/dataTransfer/FileList.js +23 -0
- package/dist/utils/edit/calculateNewValue.d.ts +12 -5
- package/dist/utils/edit/calculateNewValue.js +19 -21
- package/dist/utils/edit/editInputElement.d.ts +16 -0
- package/dist/utils/edit/{fireInputEvent.js → editInputElement.js} +20 -26
- package/dist/utils/edit/isContentEditable.d.ts +4 -0
- package/dist/utils/edit/isContentEditable.js +14 -0
- package/dist/utils/edit/isEditable.d.ts +1 -0
- package/dist/utils/edit/prepareInput.d.ts +7 -0
- package/dist/utils/edit/prepareInput.js +77 -0
- package/dist/utils/edit/setFiles.d.ts +12 -0
- package/dist/utils/edit/setFiles.js +72 -0
- package/dist/utils/focus/copySelection.d.ts +1 -0
- package/dist/utils/focus/copySelection.js +36 -0
- package/dist/utils/focus/focus.js +3 -0
- package/dist/utils/focus/selectAll.d.ts +5 -0
- package/dist/utils/focus/selectAll.js +51 -0
- package/dist/utils/focus/selection.d.ts +42 -0
- package/dist/utils/focus/selection.js +190 -0
- package/dist/utils/index.d.ts +11 -4
- package/dist/utils/index.js +124 -33
- package/dist/utils/misc/getDocumentFromNode.d.ts +1 -0
- package/dist/utils/misc/getDocumentFromNode.js +14 -0
- package/dist/utils/pointer/firePointerEvents.d.ts +12 -1
- package/dist/utils/pointer/firePointerEvents.js +62 -5
- package/package.json +1 -1
- package/dist/clear.js +0 -46
- package/dist/click.d.ts +0 -9
- package/dist/click.js +0 -62
- package/dist/hover.d.ts +0 -4
- package/dist/hover.js +0 -43
- package/dist/keyboard/getNextKeyDef.js +0 -85
- package/dist/keyboard/keyboardImplementation.d.ts +0 -3
- package/dist/keyboard/keyboardImplementation.js +0 -169
- package/dist/keyboard/specialCharMap.d.ts +0 -22
- package/dist/keyboard/specialCharMap.js +0 -30
- package/dist/paste.d.ts +0 -7
- package/dist/paste.js +0 -67
- package/dist/selectOptions.d.ts +0 -4
- package/dist/setup.d.ts +0 -92
- package/dist/setup.js +0 -203
- package/dist/tab.d.ts +0 -5
- package/dist/tab.js +0 -12
- package/dist/type.d.ts +0 -14
- package/dist/type.js +0 -74
- package/dist/upload.d.ts +0 -10
- package/dist/utils/edit/cursorPosition.d.ts +0 -2
- package/dist/utils/edit/cursorPosition.js +0 -35
- package/dist/utils/edit/fireInputEvent.d.ts +0 -8
- package/dist/utils/edit/selectionRange.d.ts +0 -5
- package/dist/utils/edit/selectionRange.js +0 -64
- package/dist/utils/pointer/fakeEvent.d.ts +0 -20
- package/dist/utils/pointer/fakeEvent.js +0 -91
|
@@ -26,51 +26,52 @@ const modifierKeys = {
|
|
|
26
26
|
const preKeydownBehavior = [// modifierKeys switch on the modifier BEFORE the keydown event
|
|
27
27
|
...Object.entries(modifierKeys).map(([key, modKey]) => ({
|
|
28
28
|
matches: keyDef => keyDef.key === key,
|
|
29
|
-
handle: (keyDef, element,
|
|
30
|
-
|
|
29
|
+
handle: (keyDef, element, {
|
|
30
|
+
keyboardState
|
|
31
|
+
}) => {
|
|
32
|
+
keyboardState.modifiers[modKey] = true;
|
|
31
33
|
}
|
|
32
34
|
})), // AltGraph produces an extra keydown for Control
|
|
33
35
|
// The modifier does not change
|
|
34
36
|
{
|
|
35
37
|
matches: keyDef => keyDef.key === 'AltGraph',
|
|
36
|
-
handle: (keyDef, element,
|
|
37
|
-
|
|
38
|
+
handle: (keyDef, element, {
|
|
39
|
+
keyboardMap,
|
|
40
|
+
keyboardState
|
|
41
|
+
}) => {
|
|
42
|
+
var _keyboardMap$find;
|
|
38
43
|
|
|
39
|
-
const ctrlKeyDef = (
|
|
44
|
+
const ctrlKeyDef = (_keyboardMap$find = keyboardMap.find(k => k.key === 'Control')) != null ? _keyboardMap$find :
|
|
40
45
|
/* istanbul ignore next */
|
|
41
46
|
{
|
|
42
47
|
key: 'Control',
|
|
43
48
|
code: 'Control'
|
|
44
49
|
};
|
|
45
50
|
|
|
46
|
-
_dom.fireEvent.keyDown(element, (0, _getEventProps.getKeyEventProps)(ctrlKeyDef,
|
|
51
|
+
_dom.fireEvent.keyDown(element, (0, _getEventProps.getKeyEventProps)(ctrlKeyDef, keyboardState));
|
|
47
52
|
}
|
|
48
53
|
}];
|
|
49
54
|
exports.preKeydownBehavior = preKeydownBehavior;
|
|
50
55
|
const keydownBehavior = [{
|
|
51
56
|
matches: keyDef => keyDef.key === 'CapsLock',
|
|
52
|
-
handle: (keyDef, element,
|
|
53
|
-
|
|
57
|
+
handle: (keyDef, element, {
|
|
58
|
+
keyboardState
|
|
59
|
+
}) => {
|
|
60
|
+
keyboardState.modifiers.caps = !keyboardState.modifiers.caps;
|
|
54
61
|
}
|
|
55
62
|
}, {
|
|
56
|
-
matches: (keyDef, element) => keyDef.key === 'Backspace' && (0, _utils.isEditable)(element)
|
|
63
|
+
matches: (keyDef, element) => keyDef.key === 'Backspace' && (0, _utils.isEditable)(element),
|
|
57
64
|
handle: (keyDef, element) => {
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
} = (0, _utils.calculateNewValue)('', element, undefined, undefined, 'backward');
|
|
62
|
-
(0, _utils.fireInputEvent)(element, {
|
|
63
|
-
newValue,
|
|
64
|
-
newSelectionStart,
|
|
65
|
-
eventOverrides: {
|
|
66
|
-
inputType: 'deleteContentBackward'
|
|
67
|
-
}
|
|
68
|
-
});
|
|
65
|
+
var _prepareInput;
|
|
66
|
+
|
|
67
|
+
(_prepareInput = (0, _utils.prepareInput)('', element, 'deleteContentBackward')) == null ? void 0 : _prepareInput.commit();
|
|
69
68
|
}
|
|
70
69
|
}, {
|
|
71
70
|
matches: keyDef => keyDef.key === 'Tab',
|
|
72
|
-
handle: (keyDef, element,
|
|
73
|
-
|
|
71
|
+
handle: (keyDef, element, {
|
|
72
|
+
keyboardState
|
|
73
|
+
}) => {
|
|
74
|
+
const dest = (0, _utils.getTabDestination)(element, keyboardState.modifiers.shift);
|
|
74
75
|
|
|
75
76
|
if (dest === element.ownerDocument.body) {
|
|
76
77
|
(0, _utils.blur)(element);
|
|
@@ -78,7 +79,10 @@ const keydownBehavior = [{
|
|
|
78
79
|
(0, _utils.focus)(dest);
|
|
79
80
|
|
|
80
81
|
if ((0, _utils.isElementType)(dest, ['input', 'textarea'])) {
|
|
81
|
-
(0, _document.setUISelection)(dest,
|
|
82
|
+
(0, _document.setUISelection)(dest, {
|
|
83
|
+
anchorOffset: 0,
|
|
84
|
+
focusOffset: dest.value.length
|
|
85
|
+
});
|
|
82
86
|
}
|
|
83
87
|
}
|
|
84
88
|
}
|
|
@@ -96,8 +100,10 @@ const keypressBehavior = [{
|
|
|
96
100
|
}, {
|
|
97
101
|
matches: (keyDef, element) => keyDef.key === 'Enter' && ((0, _utils.isClickableInput)(element) || // Links with href defined should handle Enter the same as a click
|
|
98
102
|
(0, _utils.isElementType)(element, 'a') && Boolean(element.href)),
|
|
99
|
-
handle: (keyDef, element,
|
|
100
|
-
|
|
103
|
+
handle: (keyDef, element, {
|
|
104
|
+
keyboardState
|
|
105
|
+
}) => {
|
|
106
|
+
_dom.fireEvent.click(element, (0, _getEventProps.getMouseEventProps)(keyboardState));
|
|
101
107
|
}
|
|
102
108
|
}, {
|
|
103
109
|
matches: (keyDef, element) => keyDef.key === 'Enter' && (0, _utils.isElementType)(element, 'input'),
|
|
@@ -113,15 +119,19 @@ exports.keypressBehavior = keypressBehavior;
|
|
|
113
119
|
const preKeyupBehavior = [// modifierKeys switch off the modifier BEFORE the keyup event
|
|
114
120
|
...Object.entries(modifierKeys).map(([key, modKey]) => ({
|
|
115
121
|
matches: keyDef => keyDef.key === key,
|
|
116
|
-
handle: (keyDef, element,
|
|
117
|
-
|
|
122
|
+
handle: (keyDef, element, {
|
|
123
|
+
keyboardState
|
|
124
|
+
}) => {
|
|
125
|
+
keyboardState.modifiers[modKey] = false;
|
|
118
126
|
}
|
|
119
127
|
}))];
|
|
120
128
|
exports.preKeyupBehavior = preKeyupBehavior;
|
|
121
129
|
const keyupBehavior = [{
|
|
122
130
|
matches: (keyDef, element) => keyDef.key === ' ' && (0, _utils.isClickableInput)(element),
|
|
123
|
-
handle: (keyDef, element,
|
|
124
|
-
|
|
131
|
+
handle: (keyDef, element, {
|
|
132
|
+
keyboardState
|
|
133
|
+
}) => {
|
|
134
|
+
_dom.fireEvent.click(element, (0, _getEventProps.getMouseEventProps)(keyboardState));
|
|
125
135
|
}
|
|
126
136
|
}];
|
|
127
137
|
exports.keyupBehavior = keyupBehavior;
|
|
@@ -129,17 +139,20 @@ const postKeyupBehavior = [// AltGraph produces an extra keyup for Control
|
|
|
129
139
|
// The modifier does not change
|
|
130
140
|
{
|
|
131
141
|
matches: keyDef => keyDef.key === 'AltGraph',
|
|
132
|
-
handle: (keyDef, element,
|
|
133
|
-
|
|
142
|
+
handle: (keyDef, element, {
|
|
143
|
+
keyboardMap,
|
|
144
|
+
keyboardState
|
|
145
|
+
}) => {
|
|
146
|
+
var _keyboardMap$find2;
|
|
134
147
|
|
|
135
|
-
const ctrlKeyDef = (
|
|
148
|
+
const ctrlKeyDef = (_keyboardMap$find2 = keyboardMap.find(k => k.key === 'Control')) != null ? _keyboardMap$find2 :
|
|
136
149
|
/* istanbul ignore next */
|
|
137
150
|
{
|
|
138
151
|
key: 'Control',
|
|
139
152
|
code: 'Control'
|
|
140
153
|
};
|
|
141
154
|
|
|
142
|
-
_dom.fireEvent.keyUp(element, (0, _getEventProps.getKeyEventProps)(ctrlKeyDef,
|
|
155
|
+
_dom.fireEvent.keyUp(element, (0, _getEventProps.getKeyEventProps)(ctrlKeyDef, keyboardState));
|
|
143
156
|
}
|
|
144
157
|
}];
|
|
145
158
|
exports.postKeyupBehavior = postKeyupBehavior;
|
|
@@ -1,5 +1,4 @@
|
|
|
1
1
|
import { behaviorPlugin } from '../types';
|
|
2
|
-
export declare const replaceBehavior: behaviorPlugin[];
|
|
3
2
|
export declare const preKeydownBehavior: behaviorPlugin[];
|
|
4
3
|
export declare const keydownBehavior: behaviorPlugin[];
|
|
5
4
|
export declare const keypressBehavior: behaviorPlugin[];
|
|
@@ -3,9 +3,7 @@
|
|
|
3
3
|
Object.defineProperty(exports, "__esModule", {
|
|
4
4
|
value: true
|
|
5
5
|
});
|
|
6
|
-
exports.
|
|
7
|
-
|
|
8
|
-
var _utils = require("../../utils");
|
|
6
|
+
exports.preKeyupBehavior = exports.preKeydownBehavior = exports.postKeyupBehavior = exports.keyupBehavior = exports.keypressBehavior = exports.keydownBehavior = void 0;
|
|
9
7
|
|
|
10
8
|
var arrowKeys = _interopRequireWildcard(require("./arrow"));
|
|
11
9
|
|
|
@@ -15,20 +13,15 @@ var characterKeys = _interopRequireWildcard(require("./character"));
|
|
|
15
13
|
|
|
16
14
|
var functionalKeys = _interopRequireWildcard(require("./functional"));
|
|
17
15
|
|
|
16
|
+
var combination = _interopRequireWildcard(require("./combination"));
|
|
17
|
+
|
|
18
18
|
function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
|
|
19
19
|
|
|
20
20
|
function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
|
|
21
21
|
|
|
22
|
-
const replaceBehavior = [{
|
|
23
|
-
matches: (keyDef, element) => keyDef.key === 'selectall' && (0, _utils.isElementType)(element, ['input', 'textarea']),
|
|
24
|
-
handle: (keyDef, element) => {
|
|
25
|
-
(0, _utils.setSelectionRange)(element, 0, (0, _utils.getValue)(element).length);
|
|
26
|
-
}
|
|
27
|
-
}];
|
|
28
|
-
exports.replaceBehavior = replaceBehavior;
|
|
29
22
|
const preKeydownBehavior = [...functionalKeys.preKeydownBehavior];
|
|
30
23
|
exports.preKeydownBehavior = preKeydownBehavior;
|
|
31
|
-
const keydownBehavior = [...arrowKeys.keydownBehavior, ...controlKeys.keydownBehavior, ...functionalKeys.keydownBehavior];
|
|
24
|
+
const keydownBehavior = [...arrowKeys.keydownBehavior, ...controlKeys.keydownBehavior, ...functionalKeys.keydownBehavior, ...combination.keydownBehavior];
|
|
32
25
|
exports.keydownBehavior = keydownBehavior;
|
|
33
26
|
const keypressBehavior = [...functionalKeys.keypressBehavior, ...characterKeys.keypressBehavior];
|
|
34
27
|
exports.keypressBehavior = keypressBehavior;
|
package/dist/keyboard/types.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { Config } from '../setup';
|
|
2
2
|
/**
|
|
3
3
|
* @internal Do not create/alter this by yourself as this type might be subject to changes.
|
|
4
4
|
*/
|
|
@@ -39,20 +39,6 @@ export declare type keyboardState = {
|
|
|
39
39
|
E.g. ^1
|
|
40
40
|
*/
|
|
41
41
|
carryChar: string;
|
|
42
|
-
/**
|
|
43
|
-
Repeat keydown and keypress event
|
|
44
|
-
*/
|
|
45
|
-
repeatKey?: ReturnType<typeof getNextKeyDef>;
|
|
46
|
-
};
|
|
47
|
-
export declare type keyboardOptions = {
|
|
48
|
-
/** Document in which to perform the events */
|
|
49
|
-
document: Document;
|
|
50
|
-
/** Delay between keystrokes */
|
|
51
|
-
delay: number;
|
|
52
|
-
/** Add modifiers for given keys - not implemented yet */
|
|
53
|
-
autoModify: boolean;
|
|
54
|
-
/** Keyboard layout to use */
|
|
55
|
-
keyboardMap: keyboardKey[];
|
|
56
42
|
};
|
|
57
43
|
export declare enum DOM_KEY_LOCATION {
|
|
58
44
|
STANDARD = 0,
|
|
@@ -67,14 +53,12 @@ export interface keyboardKey {
|
|
|
67
53
|
key?: string;
|
|
68
54
|
/** Location on the keyboard for keys with multiple representation */
|
|
69
55
|
location?: DOM_KEY_LOCATION;
|
|
70
|
-
/** keyCode for legacy support */
|
|
71
|
-
keyCode?: number;
|
|
72
56
|
/** Does the character in `key` require/imply AltRight to be pressed? */
|
|
73
57
|
altGr?: boolean;
|
|
74
58
|
/** Does the character in `key` require/imply a shiftKey to be pressed? */
|
|
75
59
|
shift?: boolean;
|
|
76
60
|
}
|
|
77
61
|
export interface behaviorPlugin {
|
|
78
|
-
matches: (keyDef: keyboardKey, element: Element,
|
|
79
|
-
handle: (keyDef: keyboardKey, element: Element,
|
|
62
|
+
matches: (keyDef: keyboardKey, element: Element, config: Config) => boolean;
|
|
63
|
+
handle: (keyDef: keyboardKey, element: Element, config: Config) => void;
|
|
80
64
|
}
|
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
import type { keyboardKey } from './keyboard/types';
|
|
2
|
+
import type { pointerKey } from './pointer/types';
|
|
3
|
+
export interface Options {
|
|
4
|
+
/**
|
|
5
|
+
* When using `userEvent.upload`, automatically discard files
|
|
6
|
+
* that don't match an `accept` property if it exists.
|
|
7
|
+
*
|
|
8
|
+
* @default true
|
|
9
|
+
*/
|
|
10
|
+
applyAccept?: boolean;
|
|
11
|
+
/**
|
|
12
|
+
* We intend to automatically apply modifier keys for printable characters in the future.
|
|
13
|
+
* I.e. `A` implying `{Shift>}a{/Shift}` if caps lock is not active.
|
|
14
|
+
*
|
|
15
|
+
* This options allows you to opt out of this change in foresight.
|
|
16
|
+
* The feature therefore will not constitute a breaking change.
|
|
17
|
+
*
|
|
18
|
+
* @default true
|
|
19
|
+
*/
|
|
20
|
+
autoModify?: boolean;
|
|
21
|
+
/**
|
|
22
|
+
* Between some subsequent inputs like typing a series of characters
|
|
23
|
+
* the code execution is delayed per `setTimeout` for (at least) `delay` seconds.
|
|
24
|
+
* This moves the next changes at least to next macro task
|
|
25
|
+
* and allows other (asynchronous) code to run between events.
|
|
26
|
+
*
|
|
27
|
+
* `null` prevents `setTimeout` from being called.
|
|
28
|
+
*
|
|
29
|
+
* @default 0
|
|
30
|
+
*/
|
|
31
|
+
delay?: number | null;
|
|
32
|
+
/**
|
|
33
|
+
* The document.
|
|
34
|
+
*
|
|
35
|
+
* This defaults to the owner document of an element if an API is called directly with an element and without setup.
|
|
36
|
+
* Otherwise it falls back to the global document.
|
|
37
|
+
*
|
|
38
|
+
* @default element.ownerDocument??global.document
|
|
39
|
+
*/
|
|
40
|
+
document?: Document;
|
|
41
|
+
/**
|
|
42
|
+
* An array of keyboard keys the keyboard device consists of.
|
|
43
|
+
*
|
|
44
|
+
* This allows to plug in different layouts / localizations.
|
|
45
|
+
*
|
|
46
|
+
* Defaults to a "standard" US-104-QWERTY keyboard.
|
|
47
|
+
*/
|
|
48
|
+
keyboardMap?: keyboardKey[];
|
|
49
|
+
/**
|
|
50
|
+
* An array of available pointer keys.
|
|
51
|
+
*
|
|
52
|
+
* This allows to plug in different pointer devices.
|
|
53
|
+
*/
|
|
54
|
+
pointerMap?: pointerKey[];
|
|
55
|
+
/**
|
|
56
|
+
* `userEvent.type` automatically releases any keys still pressed at the end of the call.
|
|
57
|
+
* This option allows to opt out of this feature.
|
|
58
|
+
*
|
|
59
|
+
* @default false
|
|
60
|
+
*/
|
|
61
|
+
skipAutoClose?: boolean;
|
|
62
|
+
/**
|
|
63
|
+
* `userEvent.type` implys a click at the end of the element content/value.
|
|
64
|
+
* This option allows to opt out of this feature.
|
|
65
|
+
*
|
|
66
|
+
* @default false
|
|
67
|
+
*/
|
|
68
|
+
skipClick?: boolean;
|
|
69
|
+
/**
|
|
70
|
+
* `userEvent.click` implys moving the cursor to the target element first.
|
|
71
|
+
* This options allows to opt out of this feature.
|
|
72
|
+
*
|
|
73
|
+
* @default false
|
|
74
|
+
*/
|
|
75
|
+
skipHover?: boolean;
|
|
76
|
+
/**
|
|
77
|
+
* Calling pointer related APIs on an element triggers a check if that element can receive pointer events.
|
|
78
|
+
* This check is known to be expensive.
|
|
79
|
+
* This option allows to skip the check.
|
|
80
|
+
*
|
|
81
|
+
* @default false
|
|
82
|
+
*/
|
|
83
|
+
skipPointerEventsCheck?: boolean;
|
|
84
|
+
/**
|
|
85
|
+
* Write selected data to Clipboard API when a `cut` or `copy` is triggered.
|
|
86
|
+
*
|
|
87
|
+
* The Clipboard API is usually not available to test code.
|
|
88
|
+
* Our `setup` replaces the `navigator.clipboard` property with a stub.
|
|
89
|
+
*
|
|
90
|
+
* Defaults to `false` when calling the APIs directly.
|
|
91
|
+
* Defaults to `true` when calling the APIs per `setup`.
|
|
92
|
+
*/
|
|
93
|
+
writeToClipboard?: boolean;
|
|
94
|
+
}
|
|
95
|
+
/**
|
|
96
|
+
* Default options applied when API is called per `userEvent.anyApi()`
|
|
97
|
+
*/
|
|
98
|
+
export declare const defaultOptionsDirect: Required<Options>;
|
|
99
|
+
/**
|
|
100
|
+
* Default options applied when API is called per `userEvent().anyApi()`
|
|
101
|
+
*/
|
|
102
|
+
export declare const defaultOptionsSetup: Required<Options>;
|
package/dist/options.js
ADDED
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
|
|
3
|
+
Object.defineProperty(exports, "__esModule", {
|
|
4
|
+
value: true
|
|
5
|
+
});
|
|
6
|
+
exports.defaultOptionsSetup = exports.defaultOptionsDirect = void 0;
|
|
7
|
+
|
|
8
|
+
var _keyMap = require("./keyboard/keyMap");
|
|
9
|
+
|
|
10
|
+
var _keyMap2 = require("./pointer/keyMap");
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Default options applied when API is called per `userEvent.anyApi()`
|
|
14
|
+
*/
|
|
15
|
+
const defaultOptionsDirect = {
|
|
16
|
+
applyAccept: true,
|
|
17
|
+
autoModify: true,
|
|
18
|
+
delay: 0,
|
|
19
|
+
document: global.document,
|
|
20
|
+
keyboardMap: _keyMap.defaultKeyMap,
|
|
21
|
+
pointerMap: _keyMap2.defaultKeyMap,
|
|
22
|
+
skipAutoClose: false,
|
|
23
|
+
skipClick: false,
|
|
24
|
+
skipHover: false,
|
|
25
|
+
skipPointerEventsCheck: false,
|
|
26
|
+
writeToClipboard: false
|
|
27
|
+
};
|
|
28
|
+
/**
|
|
29
|
+
* Default options applied when API is called per `userEvent().anyApi()`
|
|
30
|
+
*/
|
|
31
|
+
|
|
32
|
+
exports.defaultOptionsDirect = defaultOptionsDirect;
|
|
33
|
+
const defaultOptionsSetup = { ...defaultOptionsDirect,
|
|
34
|
+
writeToClipboard: true
|
|
35
|
+
};
|
|
36
|
+
exports.defaultOptionsSetup = defaultOptionsSetup;
|
package/dist/pointer/index.d.ts
CHANGED
|
@@ -1,18 +1,10 @@
|
|
|
1
|
+
import { UserEvent } from '../setup';
|
|
1
2
|
import { PointerAction, PointerActionTarget } from './pointerAction';
|
|
2
|
-
import type {
|
|
3
|
-
export
|
|
4
|
-
delay: 0;
|
|
5
|
-
} & inputDeviceState>): pointerState;
|
|
6
|
-
export declare function pointer(input: PointerInput, options: Partial<pointerOptions & {
|
|
7
|
-
delay: number;
|
|
8
|
-
} & inputDeviceState>): Promise<pointerState>;
|
|
3
|
+
import type { pointerState, pointerKey } from './types';
|
|
4
|
+
export type { pointerState, pointerKey };
|
|
9
5
|
declare type PointerActionInput = string | ({
|
|
10
6
|
keys: string;
|
|
11
7
|
} & PointerActionTarget) | PointerAction;
|
|
12
|
-
declare type PointerInput = PointerActionInput | Array<PointerActionInput>;
|
|
13
|
-
export declare function
|
|
14
|
-
|
|
15
|
-
pointerState: pointerState;
|
|
16
|
-
};
|
|
17
|
-
export declare function createPointerState(): pointerState;
|
|
18
|
-
export {};
|
|
8
|
+
export declare type PointerInput = PointerActionInput | Array<PointerActionInput>;
|
|
9
|
+
export declare function pointer(this: UserEvent, input: PointerInput): Promise<void>;
|
|
10
|
+
export declare function createPointerState(document: Document): pointerState;
|
package/dist/pointer/index.js
CHANGED
|
@@ -5,74 +5,40 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
5
5
|
});
|
|
6
6
|
exports.createPointerState = createPointerState;
|
|
7
7
|
exports.pointer = pointer;
|
|
8
|
-
exports.pointerImplementationWrapper = pointerImplementationWrapper;
|
|
9
8
|
|
|
10
|
-
var
|
|
11
|
-
|
|
12
|
-
var _keyboard = require("../keyboard");
|
|
9
|
+
var _setup = require("../setup");
|
|
13
10
|
|
|
14
11
|
var _parseKeyDef = require("./parseKeyDef");
|
|
15
12
|
|
|
16
|
-
var _keyMap = require("./keyMap");
|
|
17
|
-
|
|
18
13
|
var _pointerAction = require("./pointerAction");
|
|
19
14
|
|
|
20
|
-
function pointer(input
|
|
21
|
-
var _options$delay;
|
|
22
|
-
|
|
23
|
-
const {
|
|
24
|
-
promise,
|
|
25
|
-
pointerState
|
|
26
|
-
} = pointerImplementationWrapper(input, options);
|
|
27
|
-
|
|
28
|
-
if (((_options$delay = options.delay) != null ? _options$delay : 0) > 0) {
|
|
29
|
-
return (0, _dom.getConfig)().asyncWrapper(() => promise.then(() => pointerState));
|
|
30
|
-
} else {
|
|
31
|
-
// prevent users from dealing with UnhandledPromiseRejectionWarning in sync call
|
|
32
|
-
promise.catch(console.error);
|
|
33
|
-
return pointerState;
|
|
34
|
-
}
|
|
35
|
-
}
|
|
36
|
-
|
|
37
|
-
function pointerImplementationWrapper(input, config) {
|
|
15
|
+
async function pointer(input) {
|
|
38
16
|
const {
|
|
39
|
-
pointerState = createPointerState(),
|
|
40
|
-
keyboardState = (0, _keyboard.createKeyboardState)(),
|
|
41
|
-
delay = 0,
|
|
42
|
-
pointerMap = _keyMap.defaultKeyMap
|
|
43
|
-
} = config;
|
|
44
|
-
const options = {
|
|
45
|
-
delay,
|
|
46
17
|
pointerMap
|
|
47
|
-
};
|
|
18
|
+
} = this[_setup.Config];
|
|
48
19
|
const actions = [];
|
|
49
20
|
(Array.isArray(input) ? input : [input]).forEach(actionInput => {
|
|
50
21
|
if (typeof actionInput === 'string') {
|
|
51
|
-
actions.push(...(0, _parseKeyDef.parseKeyDef)(
|
|
22
|
+
actions.push(...(0, _parseKeyDef.parseKeyDef)(pointerMap, actionInput));
|
|
52
23
|
} else if ('keys' in actionInput) {
|
|
53
|
-
actions.push(...(0, _parseKeyDef.parseKeyDef)(actionInput.keys
|
|
24
|
+
actions.push(...(0, _parseKeyDef.parseKeyDef)(pointerMap, actionInput.keys).map(i => ({ ...actionInput,
|
|
54
25
|
...i
|
|
55
26
|
})));
|
|
56
27
|
} else {
|
|
57
28
|
actions.push(actionInput);
|
|
58
29
|
}
|
|
59
30
|
});
|
|
60
|
-
return
|
|
61
|
-
promise: (0, _pointerAction.pointerAction)(actions, options, {
|
|
62
|
-
pointerState,
|
|
63
|
-
keyboardState
|
|
64
|
-
}),
|
|
65
|
-
pointerState
|
|
66
|
-
};
|
|
31
|
+
return (0, _pointerAction.pointerAction)(this[_setup.Config], actions).then(() => undefined);
|
|
67
32
|
}
|
|
68
33
|
|
|
69
|
-
function createPointerState() {
|
|
34
|
+
function createPointerState(document) {
|
|
70
35
|
return {
|
|
71
36
|
pointerId: 1,
|
|
72
37
|
position: {
|
|
73
38
|
mouse: {
|
|
74
39
|
pointerType: 'mouse',
|
|
75
40
|
pointerId: 1,
|
|
41
|
+
target: document.body,
|
|
76
42
|
coords: {
|
|
77
43
|
clientX: 0,
|
|
78
44
|
clientY: 0,
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { pointerKey
|
|
2
|
-
export declare function parseKeyDef(
|
|
1
|
+
import { pointerKey } from './types';
|
|
2
|
+
export declare function parseKeyDef(pointerMap: pointerKey[], keys: string): {
|
|
3
3
|
keyDef: pointerKey;
|
|
4
4
|
releasePrevious: boolean;
|
|
5
5
|
releaseSelf: boolean;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
|
+
import { Config } from '../setup';
|
|
1
2
|
import { PointerMoveAction } from './pointerMove';
|
|
2
3
|
import { PointerPressAction } from './pointerPress';
|
|
3
|
-
import {
|
|
4
|
+
import { PointerTarget, SelectionTarget } from './types';
|
|
4
5
|
export declare type PointerActionTarget = Partial<PointerTarget> & Partial<SelectionTarget>;
|
|
5
6
|
export declare type PointerAction = PointerActionTarget & (Omit<PointerPressAction, 'target' | 'coords'> | Omit<PointerMoveAction, 'target' | 'coords'>);
|
|
6
|
-
export declare function pointerAction(actions: PointerAction[]
|
|
7
|
+
export declare function pointerAction(config: Config, actions: PointerAction[]): Promise<void>;
|
|
@@ -11,36 +11,30 @@ var _pointerMove = require("./pointerMove");
|
|
|
11
11
|
|
|
12
12
|
var _pointerPress = require("./pointerPress");
|
|
13
13
|
|
|
14
|
-
async function pointerAction(
|
|
15
|
-
const ret = [];
|
|
16
|
-
|
|
14
|
+
async function pointerAction(config, actions) {
|
|
17
15
|
for (let i = 0; i < actions.length; i++) {
|
|
18
16
|
var _action$target, _action$coords;
|
|
19
17
|
|
|
20
18
|
const action = actions[i];
|
|
21
19
|
const pointerName = 'pointerName' in action && action.pointerName ? action.pointerName : 'keyDef' in action ? action.keyDef.pointerType === 'touch' ? action.keyDef.name : action.keyDef.pointerType : 'mouse';
|
|
22
|
-
const target = (_action$target = action.target) != null ? _action$target : getPrevTarget(pointerName,
|
|
23
|
-
const coords = (_action$coords = action.coords) != null ? _action$coords : pointerName in
|
|
24
|
-
|
|
20
|
+
const target = (_action$target = action.target) != null ? _action$target : getPrevTarget(pointerName, config.pointerState);
|
|
21
|
+
const coords = (_action$coords = action.coords) != null ? _action$coords : pointerName in config.pointerState.position ? config.pointerState.position[pointerName].coords : undefined;
|
|
22
|
+
await ('keyDef' in action ? (0, _pointerPress.pointerPress)({ ...action,
|
|
25
23
|
target,
|
|
26
24
|
coords
|
|
27
|
-
},
|
|
25
|
+
}, config) : (0, _pointerMove.pointerMove)({ ...action,
|
|
28
26
|
target,
|
|
29
27
|
coords
|
|
30
|
-
},
|
|
31
|
-
ret.push(promise);
|
|
32
|
-
|
|
33
|
-
if (options.delay > 0) {
|
|
34
|
-
await promise;
|
|
28
|
+
}, config));
|
|
35
29
|
|
|
30
|
+
if (typeof config.delay === 'number') {
|
|
36
31
|
if (i < actions.length - 1) {
|
|
37
|
-
await (0, _utils.wait)(
|
|
32
|
+
await (0, _utils.wait)(config.delay);
|
|
38
33
|
}
|
|
39
34
|
}
|
|
40
35
|
}
|
|
41
36
|
|
|
42
|
-
delete
|
|
43
|
-
return Promise.all(ret);
|
|
37
|
+
delete config.pointerState.activeClickCount;
|
|
44
38
|
}
|
|
45
39
|
|
|
46
40
|
function getPrevTarget(pointerName, state) {
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import { inputDeviceState
|
|
1
|
+
import { inputDeviceState } from '../setup';
|
|
2
|
+
import { PointerTarget, SelectionTarget } from './types';
|
|
2
3
|
export interface PointerMoveAction extends PointerTarget, SelectionTarget {
|
|
3
4
|
pointerName?: string;
|
|
4
5
|
}
|
|
@@ -58,31 +58,42 @@ async function pointerMove({
|
|
|
58
58
|
fireMove(target, coords);
|
|
59
59
|
|
|
60
60
|
if (selectionRange) {
|
|
61
|
+
// TODO: support extending range (shift)
|
|
61
62
|
const selectionFocus = (0, _resolveSelectionTarget.resolveSelectionTarget)({
|
|
62
63
|
target,
|
|
63
64
|
node,
|
|
64
65
|
offset
|
|
65
66
|
});
|
|
66
67
|
|
|
67
|
-
if ('node' in selectionRange
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
const range = selectionRange.cloneRange();
|
|
73
|
-
const cmp = selectionRange.comparePoint(selectionFocus.node, selectionFocus.offset);
|
|
74
|
-
|
|
75
|
-
if (cmp < 0) {
|
|
76
|
-
range.setStart(selectionFocus.node, selectionFocus.offset);
|
|
77
|
-
} else if (cmp > 0) {
|
|
78
|
-
range.setEnd(selectionFocus.node, selectionFocus.offset);
|
|
79
|
-
} // TODO: support multiple ranges
|
|
68
|
+
if ('node' in selectionRange) {
|
|
69
|
+
// When the mouse is dragged outside of an input/textarea,
|
|
70
|
+
// the selection is extended to the beginning or end of the input
|
|
71
|
+
// depending on pointer position.
|
|
72
|
+
// TODO: extend selection according to pointer position
|
|
80
73
|
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
74
|
+
/* istanbul ignore else */
|
|
75
|
+
if (selectionFocus.node === selectionRange.node) {
|
|
76
|
+
const anchorOffset = selectionFocus.offset < selectionRange.start ? selectionRange.end : selectionRange.start;
|
|
77
|
+
const focusOffset = selectionFocus.offset > selectionRange.end || selectionFocus.offset < selectionRange.start ? selectionFocus.offset : selectionRange.end;
|
|
78
|
+
(0, _document.setUISelection)(selectionRange.node, {
|
|
79
|
+
anchorOffset,
|
|
80
|
+
focusOffset
|
|
81
|
+
});
|
|
85
82
|
}
|
|
83
|
+
} else {
|
|
84
|
+
const range = selectionRange.cloneRange();
|
|
85
|
+
const cmp = range.comparePoint(selectionFocus.node, selectionFocus.offset);
|
|
86
|
+
|
|
87
|
+
if (cmp < 0) {
|
|
88
|
+
range.setStart(selectionFocus.node, selectionFocus.offset);
|
|
89
|
+
} else if (cmp > 0) {
|
|
90
|
+
range.setEnd(selectionFocus.node, selectionFocus.offset);
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
const selection = target.ownerDocument.getSelection();
|
|
94
|
+
selection.removeAllRanges();
|
|
95
|
+
selection.addRange(range.cloneRange());
|
|
96
|
+
}
|
|
86
97
|
}
|
|
87
98
|
|
|
88
99
|
function fireMove(eventTarget, eventCoords) {
|
|
@@ -1,4 +1,5 @@
|
|
|
1
|
-
import
|
|
1
|
+
import { inputDeviceState } from '../setup';
|
|
2
|
+
import type { pointerKey, PointerTarget, SelectionTarget } from './types';
|
|
2
3
|
export interface PointerPressAction extends PointerTarget, SelectionTarget {
|
|
3
4
|
keyDef: pointerKey;
|
|
4
5
|
releasePrevious: boolean;
|
|
@@ -274,10 +274,13 @@ function mousedownDefaultBehavior({
|
|
|
274
274
|
const [start, end] = node ? // As offset is describing a DOMOffset it is non-trivial to determine
|
|
275
275
|
// which elements might be considered in the same line of text.
|
|
276
276
|
// TODO: support expanding initial range on multiple clicks if node is given
|
|
277
|
-
[offset, offset] : getTextRange(text, offset, clickCount);
|
|
277
|
+
[offset, offset] : getTextRange(text, offset, clickCount); // TODO: implement modifying selection per shift/ctrl+mouse
|
|
278
278
|
|
|
279
279
|
if (hasValue) {
|
|
280
|
-
(0, _document.setUISelection)(target,
|
|
280
|
+
(0, _document.setUISelection)(target, {
|
|
281
|
+
anchorOffset: start != null ? start : text.length,
|
|
282
|
+
focusOffset: end != null ? end : text.length
|
|
283
|
+
});
|
|
281
284
|
position.selectionRange = {
|
|
282
285
|
node: target,
|
|
283
286
|
start: start != null ? start : 0,
|
|
@@ -303,8 +306,7 @@ function mousedownDefaultBehavior({
|
|
|
303
306
|
const range = new Range();
|
|
304
307
|
range.setStart(startNode, startOffset);
|
|
305
308
|
range.setEnd(endNode, endOffset);
|
|
306
|
-
position.selectionRange = range;
|
|
307
|
-
|
|
309
|
+
position.selectionRange = range;
|
|
308
310
|
const selection = target.ownerDocument.getSelection();
|
|
309
311
|
selection.removeAllRanges();
|
|
310
312
|
selection.addRange(range.cloneRange());
|