webdriverio 9.27.1 → 9.27.2

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.
@@ -42,14 +42,15 @@ import { KeyAction, PointerAction, WheelAction } from '../../utils/actions/index
42
42
  * #### Special Characters
43
43
  *
44
44
  * If you like to use special characters like e.g. `Control`, `Page Up` or `Shift`, make sure to import the
45
- * [`Key`](https://github.com/webdriverio/webdriverio/blob/main/packages/webdriverio/src/constants.ts#L352-L417) object
46
- * from the `webdriverio` package like so:
45
+ * [`Key`](/docs/api/modules#key) object from the `webdriverio` package like so:
47
46
  *
48
47
  * ```ts
49
48
  * import { Key } from 'webdriverio'
50
49
  * ```
51
50
  *
52
- * The object allows you to access the unicode representation of the desired special character.
51
+ * The `Key` object provides constants for all special keys including `Key.Ctrl` (cross-platform), `Key.Enter`,
52
+ * `Key.Tab`, `Key.ArrowLeft`, arrow keys, function keys, and more. See the [Key API docs](/docs/api/modules#key)
53
+ * for a complete list.
53
54
  *
54
55
  * ### Pointer input source
55
56
  *
@@ -1 +1 @@
1
- {"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/action.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAc,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAChF,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmJG;AACH,wBAAgB,MAAM,CAClB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,IAAI,EAAE,KAAK,EACX,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,GACpC,SAAS,CAAA;AACZ,wBAAgB,MAAM,CAClB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,IAAI,EAAE,SAAS,EACf,IAAI,CAAC,EAAE,gBAAgB,GACxB,aAAa,CAAA;AAChB,wBAAgB,MAAM,CAClB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,IAAI,EAAE,OAAO,EACb,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,GACpC,WAAW,CAAA"}
1
+ {"version":3,"file":"action.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/action.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAc,gBAAgB,EAAE,MAAM,8BAA8B,CAAA;AAChF,OAAO,EAAE,SAAS,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAA;AAEpF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoJG;AACH,wBAAgB,MAAM,CAClB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,IAAI,EAAE,KAAK,EACX,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,GACpC,SAAS,CAAA;AACZ,wBAAgB,MAAM,CAClB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,IAAI,EAAE,SAAS,EACf,IAAI,CAAC,EAAE,gBAAgB,GACxB,aAAa,CAAA;AAChB,wBAAgB,MAAM,CAClB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,IAAI,EAAE,OAAO,EACb,IAAI,CAAC,EAAE,IAAI,CAAC,gBAAgB,EAAE,IAAI,CAAC,GACpC,WAAW,CAAA"}
@@ -1,16 +1,31 @@
1
1
  /**
2
2
  *
3
3
  * Send a sequence of key strokes to the "active" element. You can make an input element active by just clicking
4
- * on it. To use characters like "Left arrow" or "Back space", import the `Key` object from the WebdriverIO package.
4
+ * on it. To use special characters like "ArrowLeft", "Enter", or "Backspace", import the `Key` object from the WebdriverIO package:
5
5
  *
6
- * Modifier like `Control`, `Shift`, `Alt` and `Command` will stay pressed throughout the sequence and will be released
6
+ * ```js
7
+ * import { Key } from 'webdriverio'
8
+ * ```
9
+ *
10
+ * The `Key` object provides constants for all special keys including:
11
+ * - Navigation: `Key.ArrowLeft`, `Key.ArrowUp`, `Key.ArrowRight`, `Key.ArrowDown`, `Key.PageUp`, `Key.PageDown`, `Key.Home`, `Key.End`
12
+ * - Editing: `Key.Enter`, `Key.Tab`, `Key.Backspace`, `Key.Delete`, `Key.Insert`
13
+ * - Modifiers: `Key.Ctrl` (cross-platform), `Key.Shift`, `Key.Alt`, `Key.Control`, `Key.Command`
14
+ * - Function keys: `Key.F1` through `Key.F12`
15
+ * - Numpad: `Key.Numpad0` through `Key.Numpad9`, `Key.Multiply`, `Key.Add`, `Key.Subtract`, `Key.Divide`
16
+ * - And more: `Key.Escape`, `Key.Space`, `Key.Clear`, `Key.Pause`, etc.
17
+ *
18
+ * See the [Key API docs](/docs/api/modules#key) for a complete list.
19
+ *
20
+ * Modifier keys like `Control`, `Shift`, `Alt` and `Command` will stay pressed throughout the sequence and will be released
7
21
  * at the end. Modifying a click requires you to use the WebDriver Actions API through the
8
22
  * [performActions](https://webdriver.io/docs/api/webdriver#performactions) method.
9
23
  *
10
- * :::info
24
+ * :::info Cross-Platform Modifier
11
25
  *
12
- * Control keys differ based on the operating system the browser is running on, e.g. MacOS: `Command` and Windows: `Control`.
13
- * WebdriverIO provides a cross browser modifier control key called `Ctrl` (see example below).
26
+ * The `Key.Ctrl` constant provides a convenient way to use the "control" modifier across different operating systems.
27
+ * On macOS, it maps to the `Command` key, while on Windows and Linux it maps to the `Control` key.
28
+ * This is useful for keyboard shortcuts like select-all (`[Key.Ctrl, 'a']`), copy, or paste.
14
29
  *
15
30
  * :::
16
31
  *
@@ -1 +1 @@
1
- {"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/keys.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,wBAAsB,IAAI,CACtB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GACzB,OAAO,CAAC,IAAI,CAAC,CAiCf"}
1
+ {"version":3,"file":"keys.d.ts","sourceRoot":"","sources":["../../../src/commands/browser/keys.ts"],"names":[],"mappings":"AAIA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAmCG;AACH,wBAAsB,IAAI,CACtB,IAAI,EAAE,WAAW,CAAC,OAAO,EACzB,KAAK,EAAE,MAAM,GAAG,MAAM,EAAE,GACzB,OAAO,CAAC,IAAI,CAAC,CAiCf"}
@@ -6,7 +6,7 @@ import type { InputOptions } from '../../types.js';
6
6
  * :::info
7
7
  *
8
8
  * If you like to use special characters, e.g. to copy and paste a value from one input to another, use the
9
- * [`keys`](/docs/api/browser/keys) command.
9
+ * [`keys`](/docs/api/browser/keys) command with the [`Key`](/docs/api/modules#key) object.
10
10
  *
11
11
  * :::
12
12
  *
@@ -6,7 +6,7 @@ import type { InputOptions } from '../../types.js';
6
6
  * :::info
7
7
  *
8
8
  * If you like to use special characters, e.g. to copy and paste a value from one input to another, use the
9
- * [`keys`](/docs/api/browser/keys) command.
9
+ * [`keys`](/docs/api/browser/keys) command with the [`Key`](/docs/api/modules#key) object.
10
10
  *
11
11
  * :::
12
12
  *
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "webdriverio",
3
3
  "description": "Next-gen browser and mobile automation test framework for Node.js",
4
- "version": "9.27.1",
4
+ "version": "9.27.2",
5
5
  "homepage": "https://webdriver.io",
6
6
  "author": "Christian Bromann <mail@bromann.dev>",
7
7
  "license": "MIT",
@@ -77,12 +77,12 @@
77
77
  "dependencies": {
78
78
  "@types/node": "^20.11.30",
79
79
  "@types/sinonjs__fake-timers": "^8.1.5",
80
- "@wdio/config": "9.27.1",
80
+ "@wdio/config": "9.27.2",
81
81
  "@wdio/logger": "9.18.0",
82
- "@wdio/protocols": "9.27.1",
82
+ "@wdio/protocols": "9.27.2",
83
83
  "@wdio/repl": "9.16.2",
84
- "@wdio/types": "9.27.1",
85
- "@wdio/utils": "9.27.1",
84
+ "@wdio/types": "9.27.2",
85
+ "@wdio/utils": "9.27.2",
86
86
  "archiver": "^7.0.1",
87
87
  "aria-query": "^5.3.0",
88
88
  "cheerio": "^1.0.0-rc.12",
@@ -99,7 +99,7 @@
99
99
  "rgb2hex": "0.2.5",
100
100
  "serialize-error": "^12.0.0",
101
101
  "urlpattern-polyfill": "^10.0.0",
102
- "webdriver": "9.27.1"
102
+ "webdriver": "9.27.2"
103
103
  },
104
104
  "peerDependencies": {
105
105
  "puppeteer-core": ">=22.x || <=24.x"
@@ -109,5 +109,5 @@
109
109
  "optional": true
110
110
  }
111
111
  },
112
- "gitHead": "e2b5652f61da0858251860e7d3bc0c0aaffbb525"
112
+ "gitHead": "a95ab41f3ac1fd9510341a21d365a359528212ac"
113
113
  }