puppeteer/docs/api/puppeteer.keyboard.type.md

40 lines
1.7 KiB
Markdown
Raw Normal View History

2022-07-05 13:41:43 +00:00
---
sidebar_label: Keyboard.type
---
# Keyboard.type() method
Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
#### Signature:
2022-07-05 13:41:43 +00:00
```typescript
class Keyboard {
type(text: string, options?: Readonly<KeyboardTypeOptions>): Promise<void>;
2022-07-05 13:41:43 +00:00
}
```
## Parameters
| Parameter | Type | Description |
| --------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| text | string | A text to type into a focused element. |
| options | Readonly&lt;[KeyboardTypeOptions](./puppeteer.keyboardtypeoptions.md)&gt; | _(Optional)_ An object of options. Accepts delay which, if specified, is the time to wait between <code>keydown</code> and <code>keyup</code> in milliseconds. Defaults to 0. |
2022-07-05 13:41:43 +00:00
**Returns:**
Promise&lt;void&gt;
## Remarks
To press a special key, like `Control` or `ArrowDown`, use [Keyboard.press()](./puppeteer.keyboard.press.md).
Modifier keys DO NOT effect `keyboard.type`. Holding down `Shift` will not type the text in upper case.
## Example
```ts
await page.keyboard.type('Hello'); // Types instantly
await page.keyboard.type('World', {delay: 100}); // Types slower, like a user
```