puppeteer/website/versioned_docs/version-20.2.0/api/puppeteer.keyboard.down.md

sidebar_label
Keyboard.down

Keyboard.down() method

Dispatches a keydown event.

Signature:

class Keyboard {
  down(
    key: KeyInput,
    options?: {
      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	{ text?: string; commands?: string[]; }	(Optional) An object of options. Accepts text which, if specified, generates an input event with this text. 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. If key is a modifier key, Shift, Meta, Control, or Alt, subsequent key presses will be sent with that modifier active. To release the modifier key, use Keyboard.up().

After the key is pressed once, subsequent calls to Keyboard.down() will have repeat set to true. To release the key, use Keyboard.up().

Modifier keys DO influence Keyboard.down(). Holding down Shift will type the text in upper case.