mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
a63b8305ac
Co-authored-by: release-please[bot] <55107282+release-please[bot]@users.noreply.github.com>
121 lines
2.4 KiB
Markdown
121 lines
2.4 KiB
Markdown
---
|
|
sidebar_label: Keyboard
|
|
---
|
|
|
|
# Keyboard class
|
|
|
|
Keyboard provides an api for managing a virtual keyboard. The high level api is [Keyboard.type()](./puppeteer.keyboard.type.md), which takes raw characters and generates proper keydown, keypress/input, and keyup events on your page.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
export declare abstract class Keyboard
|
|
```
|
|
|
|
## Remarks
|
|
|
|
For finer control, you can use [Keyboard.down()](./puppeteer.keyboard.down.md), [Keyboard.up()](./puppeteer.keyboard.up.md), and [Keyboard.sendCharacter()](./puppeteer.keyboard.sendcharacter.md) to manually fire events as if they were generated from a real keyboard.
|
|
|
|
On macOS, keyboard shortcuts like `⌘ A` -> Select All do not work. See [\#1313](https://github.com/puppeteer/puppeteer/issues/1313).
|
|
|
|
The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `Keyboard` class.
|
|
|
|
## Example 1
|
|
|
|
An example of holding down `Shift` in order to select and delete some text:
|
|
|
|
```ts
|
|
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!'
|
|
```
|
|
|
|
## Example 2
|
|
|
|
An example of pressing `A`
|
|
|
|
```ts
|
|
await page.keyboard.down('Shift');
|
|
await page.keyboard.press('KeyA');
|
|
await page.keyboard.up('Shift');
|
|
```
|
|
|
|
## Methods
|
|
|
|
<table><thead><tr><th>
|
|
|
|
Method
|
|
|
|
</th><th>
|
|
|
|
Modifiers
|
|
|
|
</th><th>
|
|
|
|
Description
|
|
|
|
</th></tr></thead>
|
|
<tbody><tr><td>
|
|
|
|
[down(key, options)](./puppeteer.keyboard.down.md)
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
Dispatches a `keydown` event.
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[press(key, options)](./puppeteer.keyboard.press.md)
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
Shortcut for [Keyboard.down()](./puppeteer.keyboard.down.md) and [Keyboard.up()](./puppeteer.keyboard.up.md).
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[sendCharacter(char)](./puppeteer.keyboard.sendcharacter.md)
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
Dispatches a `keypress` and `input` event. This does not send a `keydown` or `keyup` event.
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[type(text, options)](./puppeteer.keyboard.type.md)
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
Sends a `keydown`, `keypress`/`input`, and `keyup` event for each character in the text.
|
|
|
|
</td></tr>
|
|
<tr><td>
|
|
|
|
[up(key)](./puppeteer.keyboard.up.md)
|
|
|
|
</td><td>
|
|
|
|
</td><td>
|
|
|
|
Dispatches a `keyup` event.
|
|
|
|
</td></tr>
|
|
</tbody></table>
|