github/puppeteer
0
0
Fork 0
mirror of https://github.com/puppeteer/puppeteer synced 2024-06-14 14:02:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(new): add TSDoc comments to Keyboard (#6099)

Browse Source 
Co-authored-by: Tim van der Lippe <tvanderlippe@google.com>
This commit is contained in:
Jack Franklin
2020-06-25 10:56:55 +01:00
committed by Mathias Bynens
parent 4696f7abda
commit 5b6d2bfb0e
12 changed files with 233 additions and 80 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
new-docs/puppeteer.keyboard.down.md
View File

@@ -4,6 +4,8 @@
## Keyboard.down() method
Dispatches a `keydown` event.
<b>Signature:</b>
```typescript
@@ -16,10 +18,18 @@ down(key: KeyInput, options?: {
| Parameter | Type | Description |
| --- | --- | --- |
| key | [KeyInput](./puppeteer.keyinput.md) | |
| options | { text?: string; } | |
| 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; } | An object of options. Accepts text which, if specified, generates an input event with this text. |
<b>Returns:</b>
Promise&lt;void&gt;
## 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.