← Back to Input domain

Input.dispatchKeyEvent

Dispatches a key event to the page.

Domain: Input stable

Parameters

NameTypeDescription
typestringType of the key event.
modifiers (optional)integerBit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).
timestamp (optional)TimeSinceEpochTime at which the event occurred.
text (optional)stringText as generated by processing a virtual key code with a keyboard layout. Not needed for for `keyUp` and `rawKeyDown` events (default: "")
unmodifiedText (optional)stringText that would have been generated by the keyboard if no modifiers were pressed (except for shift). Useful for shortcut (accelerator) key handling (default: "").
keyIdentifier (optional)stringUnique key identifier (e.g., 'U+0041') (default: "").
code (optional)stringUnique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").
key (optional)stringUnique DOM defined string value describing the meaning of the key in the context of active modifiers, keyboard layout, etc (e.g., 'AltGr') (default: "").
windowsVirtualKeyCode (optional)integerWindows virtual key code (default: 0).
nativeVirtualKeyCode (optional)integerNative virtual key code (default: 0).
autoRepeat (optional)booleanWhether the event was generated from auto repeat (default: false).
isKeypad (optional)booleanWhether the event was generated from the keypad (default: false).
isSystemKey (optional)booleanWhether the event was a system key event (default: false).
location (optional)integerWhether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default: 0).
commands (optional)arrayEditing 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.

Example Request

{
  "id": 1,
  "method": "Input.dispatchKeyEvent",
  "params": {
    "type": "type-value"
  }
}

Example Response

{
  "id": 1,
  "result": {}
}

Usage in Node.js

const result = await send('Input.dispatchKeyEvent', {"type": "type-value"});
console.log(result);