puppeteer/docs/api/puppeteer.keyboard.type.md
jrandolf f07ad2c661
fix: update documentation on configuring puppeteer (#9150)
This PR updates the docs regarding configuring puppeteer. In addition,
some changes have been made to the documentation generator to show
default values on the documentation site.

Also fixes: https://github.com/puppeteer/puppeteer/pull/9144
2022-10-24 09:07:05 +02:00

1.6 KiB

sidebar_label
Keyboard.type

Keyboard.type() method

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

Signature:

class Keyboard {
  type(
    text: string,
    options?: {
      delay?: number;
    }
  ): Promise<void>;
}

Parameters

Parameter Type Description
text string A text to type into a focused element.
options { delay?: number; } (Optional) An object of options. Accepts delay which, if specified, is the time to wait between keydown and keyup in milliseconds. Defaults to 0.

Returns:

Promise<void>

Remarks

To press a special key, like Control or ArrowDown, use Keyboard.press().

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

Example

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