Input Domain
Methods
Input.dispatchKeyEvent #
Dispatches a key event to the page.
Parameters
type
string
Type of the key event.
Allowed values: keyDown
, keyUp
, rawKeyDown
, char
modifiers
Optional
integer
Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).
timestamp
Optional
Time at which the event occurred.
text
Optional
string
Text as generated by processing a virtual key code with a keyboard layout. Not needed for
for keyUp
and rawKeyDown
events (default: "")
unmodifiedText
Optional
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: "").
keyIdentifier
Optional
string
Unique key identifier (e.g., 'U+0041') (default: "").
code
Optional
string
Unique DOM defined string value for each physical key (e.g., 'KeyA') (default: "").
key
Optional
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: "").
windowsVirtualKeyCode
Optional
integer
Windows virtual key code (default: 0).
nativeVirtualKeyCode
Optional
integer
Native virtual key code (default: 0).
autoRepeat
Optional
boolean
Whether the event was generated from auto repeat (default: false).
isKeypad
Optional
boolean
Whether the event was generated from the keypad (default: false).
isSystemKey
Optional
boolean
Whether the event was a system key event (default: false).
location
Optional
integer
Whether the event was from the left or right side of the keyboard. 1=Left, 2=Right (default: 0).
commands
Optional
array[ 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.
Input.dispatchMouseEvent #
Dispatches a mouse event to the page.
Parameters
type
string
Type of the mouse event.
Allowed values: mousePressed
, mouseReleased
, mouseMoved
, mouseWheel
x
number
X coordinate of the event relative to the main frame's viewport in CSS pixels.
y
number
Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
modifiers
Optional
integer
Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).
timestamp
Optional
Time at which the event occurred.
button
Optional
Mouse button (default: "none").
buttons
Optional
integer
A number indicating which buttons are pressed on the mouse when a mouse event is triggered. Left=1, Right=2, Middle=4, Back=8, Forward=16, None=0.
clickCount
Optional
integer
Number of times the mouse button was clicked (default: 0).
force
Optional
number
The normalized pressure, which has a range of [0,1] (default: 0).
tangentialPressure
Optional
number
The normalized tangential pressure, which has a range of [-1,1] (default: 0).
tiltX
Optional
number
The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0).
tiltY
Optional
number
The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
twist
Optional
integer
The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
deltaX
Optional
number
X delta in CSS pixels for mouse wheel event (default: 0).
deltaY
Optional
number
Y delta in CSS pixels for mouse wheel event (default: 0).
pointerType
Optional
string
Pointer type (default: "mouse").
Allowed values: mouse
, pen
Input.dispatchTouchEvent #
Dispatches a touch event to the page.
Parameters
type
string
Type of the touch event. TouchEnd and TouchCancel must not contain any touch points, while TouchStart and TouchMove must contains at least one.
Allowed values: touchStart
, touchEnd
, touchMove
, touchCancel
touchPoints
array[ TouchPoint ]
Active touch points on the touch device. One event per any changed point (compared to previous touch event in a sequence) is generated, emulating pressing/moving/releasing points one by one.
modifiers
Optional
integer
Bit field representing pressed modifier keys. Alt=1, Ctrl=2, Meta/Command=4, Shift=8 (default: 0).
timestamp
Optional
Time at which the event occurred.
Input.setIgnoreInputEvents #
Ignores input events (useful while auditing page).
Parameters
ignore
boolean
Ignores input events processing when set to true.
Types
Input.TouchPoint #
Type: object
Properties
x
number
X coordinate of the event relative to the main frame's viewport in CSS pixels.
y
number
Y coordinate of the event relative to the main frame's viewport in CSS pixels. 0 refers to the top of the viewport and Y increases as it proceeds towards the bottom of the viewport.
radiusX
Optional
number
X radius of the touch area (default: 1.0).
radiusY
Optional
number
Y radius of the touch area (default: 1.0).
rotationAngle
Optional
number
Rotation angle (default: 0.0).
force
Optional
number
Force (default: 1.0).
tangentialPressure
Optional
number
The normalized tangential pressure, which has a range of [-1,1] (default: 0).
tiltX
Optional
number
The plane angle between the Y-Z plane and the plane containing both the stylus axis and the Y axis, in degrees of the range [-90,90], a positive tiltX is to the right (default: 0)
tiltY
Optional
number
The plane angle between the X-Z plane and the plane containing both the stylus axis and the X axis, in degrees of the range [-90,90], a positive tiltY is towards the user (default: 0).
twist
Optional
integer
The clockwise rotation of a pen stylus around its own major axis, in degrees in the range [0,359] (default: 0).
id
Optional
number
Identifier used to track touch sources between events, must be unique within an event.