Skip to main content
Version: 1.15

Keyboard

Keyboard provides an api for managing a virtual keyboard. The high level api is keyboard.type(text[, options]), which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page.

For finer control, you can use keyboard.down(key), keyboard.up(key), and keyboard.insertText(text) to manually fire events as if they were generated from a real keyboard.

An example of holding down Shift in order to select and delete some text:

await page.keyboard.type('Hello World!');await page.keyboard.press('ArrowLeft');
await page.keyboard.down('Shift');for (let i = 0; i < ' World'.length; i++)  await page.keyboard.press('ArrowLeft');await page.keyboard.up('Shift');
await page.keyboard.press('Backspace');// Result text will end up saying 'Hello!'

An example of pressing uppercase A

await page.keyboard.press('Shift+KeyA');// orawait page.keyboard.press('Shift+A');

An example to trigger select-all with the keyboard

// on Windows and Linuxawait page.keyboard.press('Control+A');// on macOSawait page.keyboard.press('Meta+A');

keyboard.down(key)#

  • key <string> Name of the key to press or a character to generate, such as ArrowLeft or a.#
  • returns: <Promise<void>>#

Dispatches a keydown event.

key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values can be found here. Examples of the keys are:

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc.

Following modification shortcuts are also supported: Shift, Control, Alt, Meta, ShiftLeft.

Holding down Shift will type the text that corresponds to the key in the upper case.

If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.

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(key).

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

note

Modifier keys DO influence keyboard.down. Holding down Shift will type the text in upper case.

keyboard.insertText(text)#

Dispatches only input event, does not emit the keydown, keyup or keypress events.

page.keyboard.insertText('å—¨');
note

Modifier keys DO NOT effect keyboard.insertText. Holding down Shift will not type the text in upper case.

keyboard.press(key[, options])#

  • key <string> Name of the key to press or a character to generate, such as ArrowLeft or a.#
  • options <Object>
    • delay <number> Time to wait between keydown and keyup in milliseconds. Defaults to 0.#
  • returns: <Promise<void>>#

key can specify the intended keyboardEvent.key value or a single character to generate the text for. A superset of the key values can be found here. Examples of the keys are:

F1 - F12, Digit0- Digit9, KeyA- KeyZ, Backquote, Minus, Equal, Backslash, Backspace, Tab, Delete, Escape, ArrowDown, End, Enter, Home, Insert, PageDown, PageUp, ArrowRight, ArrowUp, etc.

Following modification shortcuts are also supported: Shift, Control, Alt, Meta, ShiftLeft.

Holding down Shift will type the text that corresponds to the key in the upper case.

If key is a single character, it is case-sensitive, so the values a and A will generate different respective texts.

Shortcuts such as key: "Control+o" or key: "Control+Shift+T" are supported as well. When specified with the modifier, modifier is pressed and being held while the subsequent key is being pressed.

const page = await browser.newPage();await page.goto('https://keycode.info');await page.keyboard.press('A');await page.screenshot({ path: 'A.png' });await page.keyboard.press('ArrowLeft');await page.screenshot({ path: 'ArrowLeft.png' });await page.keyboard.press('Shift+O');await page.screenshot({ path: 'O.png' });await browser.close();

Shortcut for keyboard.down(key) and keyboard.up(key).

keyboard.type(text[, options])#

  • text <string> A text to type into a focused element.#
  • options <Object>
    • delay <number> Time to wait between key presses in milliseconds. Defaults to 0.#
  • returns: <Promise<void>>#

Sends a keydown, keypress/input, and keyup event for each character in the text.

To press a special key, like Control or ArrowDown, use keyboard.press(key[, options]).

await page.keyboard.type('Hello'); // Types instantlyawait page.keyboard.type('World', {delay: 100}); // Types slower, like a user
note

Modifier keys DO NOT effect keyboard.type. Holding down Shift will not type the text in upper case.

note

For characters that are not on a US keyboard, only an input event will be sent.

keyboard.up(key)#

  • key <string> Name of the key to press or a character to generate, such as ArrowLeft or a.#
  • returns: <Promise<void>>#

Dispatches a keyup event.