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
5b6d2bfb0e
puppeteer/new-docs/puppeteer.keyboard.press.md
Jack Franklin 5b6d2bfb0e docs(new): add TSDoc comments to Keyboard (#6099) 
Co-authored-by: Tim van der Lippe <tvanderlippe@google.com>
2020-06-25 13:01:46 +02:00

1.5 KiB
Raw Blame History

Home > puppeteer > Keyboard > press

Keyboard.press() method

Shortcut for Keyboard.down() and Keyboard.up().

Signature:

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; } 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.