Skip to main content
Input options for the ‘hover’ mutation.

​
Definition

input HoverOptions {
  force: Boolean
  modifiers: [ModifierKey]
  position: PointOptions
  timeout: Int
  trial: Boolean
}

​
Fields

​
force

Boolean Whether to bypass normal actionability checks. Defaults to false.

​
modifiers

[ModifierKey] Array of modifier keys (e.g., SHIFT, CONTROL) to press during the hover. Example: [ALT]

​
position

PointOptions Specific point, relative to the element’s top-left corner, to hover over. Example: { x: 0, y: 0 }

​
timeout

Int Maximum time in milliseconds to wait for the element to be hoverable. Defaults to a global timeout.

​
trial

Boolean If true, the hover will not be performed if it would trigger a navigation (less common for hover). Defaults to false.
⌘I