github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
eb138635d6
puppeteer/docs/api/puppeteer.keyboard.press.md
Junyan b7ebc5d9bb
feat(puppeteer-core): keydown supports commands (#9357) 
Issue: #1313

<!-- Thanks for submitting a pull request! Please provide enough
information so that others can review your pull request. -->

**What kind of change does this PR introduce?**

Feature.

**Did you add tests for your changes?**

Yes.

**If relevant, did you update the documentation?**

Yes.

**Summary**

Supports keyboard shotcuts on MacOS. See Chrome Devtools Protocol
document:
https://chromedevtools.github.io/devtools-protocol/tot/Input/#method-dispatchKeyEvent.
2022-12-03 11:23:47 +01:00

3.1 KiB
Raw Blame History

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;
      commands?: 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; commands?: 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. Accepts commands which, if specified, is the commands of keyboard shortcuts, see Chromium Source Code for valid command names.

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.