e2d9858b38
* chore(main): release 17.0.0 * chore: generate versioned docs Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
1.9 KiB
1.9 KiB
| sidebar_label |
|---|
| Keyboard.press |
Keyboard.press() method
Shortcut for Keyboard.down() and Keyboard.up().
Signature:
class Keyboard {
press(
key: KeyInput,
options?: {
delay?: number;
text?: string;
}
): Promise<void>;
}
Parameters
| Parameter | Type | Description |
|---|---|---|
| key | KeyInput | Name of key to press, such as ArrowLeft. See KeyInput for a list of all key names. |
| options | { delay?: number; text?: string; } | (Optional) An object of options. Accepts text which, if specified, generates an input event with this text. Accepts delay which, if specified, is the time to wait between keydown and keyup in milliseconds. Defaults to 0. |
Returns:
Promise<void>
Remarks
If key is a single character and no modifier keys besides Shift are being held down, a keypress/input event will also generated. The text option can be specified to force an input event to be generated.
Modifier keys DO effect Keyboard.press(). Holding down Shift will type the text in upper case.