puppeteer/new-docs/puppeteer.protocol.input.dispatchkeyeventrequest.md

33 lines
3.7 KiB
Markdown
Raw Normal View History

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [puppeteer](./puppeteer.md) &gt; [Protocol](./puppeteer.protocol.md) &gt; [Input](./puppeteer.protocol.input.md) &gt; [DispatchKeyEventRequest](./puppeteer.protocol.input.dispatchkeyeventrequest.md)
## Protocol.Input.DispatchKeyEventRequest interface
<b>Signature:</b>
```typescript
export interface DispatchKeyEventRequest
```
## Properties
| Property | Type | Description |
| --- | --- | --- |
| [autoRepeat](./puppeteer.protocol.input.dispatchkeyeventrequest.autorepeat.md) | boolean | Whether the event was generated from auto repeat (default: false). |
| [code](./puppeteer.protocol.input.dispatchkeyeventrequest.code.md) | string | Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: ""). |
| [commands](./puppeteer.protocol.input.dispatchkeyeventrequest.commands.md) | string\[\] | Editing commands to send with the key event (e.g., 'selectAll') (default: \[\]). These are related to but not equal the command names used in <code>document.execCommand</code> and NSStandardKeyBindingResponding. See https://source.chromium.org/chromium/chromium/src/+/master:third\_party/blink/renderer/core/editing/commands/editor\_command\_names.h for valid command names. |
| [isKeypad](./puppeteer.protocol.input.dispatchkeyeventrequest.iskeypad.md) | boolean | Whether the event was generated from the keypad (default: false). |
| [isSystemKey](./puppeteer.protocol.input.dispatchkeyeventrequest.issystemkey.md) | boolean | Whether the event was a system key event (default: false). |
| [key](./puppeteer.protocol.input.dispatchkeyeventrequest.key.md) | string | Unique DOM defined string value describing the meaning of the key in the context of active modifiers, keyboard layout, etc (e.g., 'AltGr') (default: ""). |
| [keyIdentifier](./puppeteer.protocol.input.dispatchkeyeventrequest.keyidentifier.md) | string | Unique key identifier (e.g., 'U+0041') (default: ""). |
| [location](./puppeteer.protocol.input.dispatchkeyeventrequest.location.md) | [integer](./puppeteer.protocol.integer.md) | Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default: 0). |
| [modifiers](./puppeteer.protocol.input.dispatchkeyeventrequest.modifiers.md) | [integer](./puppeteer.protocol.integer.md) | Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0). |
| [nativeVirtualKeyCode](./puppeteer.protocol.input.dispatchkeyeventrequest.nativevirtualkeycode.md) | [integer](./puppeteer.protocol.integer.md) | Native virtual key code (default: 0). |
| [text](./puppeteer.protocol.input.dispatchkeyeventrequest.text.md) | string | Text as generated by processing a virtual key code with a keyboard layout. Not needed for for <code>keyUp</code> and <code>rawKeyDown</code> events (default: "") |
| [timestamp](./puppeteer.protocol.input.dispatchkeyeventrequest.timestamp.md) | [TimeSinceEpoch](./puppeteer.protocol.input.timesinceepoch.md) | Time at which the event occurred. |
| [type](./puppeteer.protocol.input.dispatchkeyeventrequest.type.md) | ('keyDown' \| 'keyUp' \| 'rawKeyDown' \| 'char') | Type of the key event. (DispatchKeyEventRequestType enum) |
| [unmodifiedText](./puppeteer.protocol.input.dispatchkeyeventrequest.unmodifiedtext.md) | string | Text that would have been generated by the keyboard if no modifiers were pressed (except for shift). Useful for shortcut (accelerator) key handling (default: ""). |
| [windowsVirtualKeyCode](./puppeteer.protocol.input.dispatchkeyeventrequest.windowsvirtualkeycode.md) | [integer](./puppeteer.protocol.integer.md) | Windows virtual key code (default: 0). |