f07ad2c661
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
40 lines
1.8 KiB
Markdown
40 lines
1.8 KiB
Markdown
---
|
|
sidebar_label: Keyboard.down
|
|
---
|
|
|
|
# Keyboard.down() method
|
|
|
|
Dispatches a `keydown` event.
|
|
|
|
#### Signature:
|
|
|
|
```typescript
|
|
class Keyboard {
|
|
down(
|
|
key: KeyInput,
|
|
options?: {
|
|
text?: string;
|
|
}
|
|
): Promise<void>;
|
|
}
|
|
```
|
|
|
|
## Parameters
|
|
|
|
| Parameter | Type | Description |
|
|
| --------- | ----------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
|
| key | [KeyInput](./puppeteer.keyinput.md) | Name of key to press, such as <code>ArrowLeft</code>. See [KeyInput](./puppeteer.keyinput.md) for a list of all key names. |
|
|
| options | { text?: string; } | <i>(Optional)</i> An object of options. Accepts text which, if specified, generates an input event with this text. |
|
|
|
|
**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()](./puppeteer.keyboard.up.md).
|
|
|
|
After the key is pressed once, subsequent calls to [Keyboard.down()](./puppeteer.keyboard.down.md) will have [repeat](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/repeat) set to true. To release the key, use [Keyboard.up()](./puppeteer.keyboard.up.md).
|
|
|
|
Modifier keys DO influence [Keyboard.down()](./puppeteer.keyboard.down.md). Holding down `Shift` will type the text in upper case.
|