Skip to main content
Module

x/puppeteer/vendor/puppeteer-core/puppeteer/api-docs-entry.js>Protocol.Input.DispatchKeyEventRequest

A port of puppeteer running on Deno
lucacasonato/deno-puppeteer
Very Popular
Go to Latest
interface Protocol.Input.DispatchKeyEventRequest
import { type Protocol } from "https://deno.land/x/puppeteer@14.1.1/vendor/puppeteer-core/puppeteer/api-docs-entry.js";
const { DispatchKeyEventRequest } = Protocol.Input;

Properties

type: (
| "keyDown"
| "keyUp"
| "rawKeyDown"
| "char"
)

Type of the key event. (DispatchKeyEventRequestType enum)

optional
modifiers: integer

Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).

optional
timestamp: TimeSinceEpoch

Time at which the event occurred.

optional
text: string

Text as generated by processing a virtual key code with a keyboard layout. Not needed for for keyUp and rawKeyDown events (default: "")

optional
unmodifiedText: 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: "").

optional
keyIdentifier: string

Unique key identifier (e.g., 'U+0041') (default: "").

optional
code: string

Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").

optional
key: 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: "").

optional
windowsVirtualKeyCode: integer

Windows virtual key code (default: 0).

optional
nativeVirtualKeyCode: integer

Native virtual key code (default: 0).

optional
autoRepeat: boolean

Whether the event was generated from auto repeat (default: false).

optional
isKeypad: boolean

Whether the event was generated from the keypad (default: false).

optional
isSystemKey: boolean

Whether the event was a system key event (default: false).

optional
location: integer

Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default: 0).

optional
commands: 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 document.execCommand and NSStandardKeyBindingResponding. See https://source.chromium.org/chromium/chromium/src/+/main:third_party/blink/renderer/core/editing/commands/editor_command_names.h for valid command names.