Skip to main content

Interface: ClickOption

Defined in: packages/core/src/interactor/MouseOption.ts:12

Extends​

Properties​

clickCount?​

optional clickCount?: number

Defined in: packages/core/src/interactor/MouseOption.ts:27

Number of clicks to dispatch as a single gesture, e.g. 2 for a double-click. Only 2 is currently implemented; omit for a single click. Two separate click() calls do not reliably register as a real double-click (actionability re-checks between calls can exceed the platform's double-click timing threshold), so a genuine double-click gesture needs this option rather than calling click() twice.

Every Interactor.click() implementation validates this via assertValidClickCount and throws for anything other than 2, so an unsupported value fails the same way in every environment instead of silently diverging (e.g. Playwright honoring a 3 while jsdom silently falls back to a single click).

Inherited members (1)

Properties​

position?​

optional position?: Point

Defined in: packages/core/src/interactor/MouseOption.ts:9

A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element. Note that in end to end tests such as Playwright, mouse interaction location is not always pixel perfect.

Inherited from​

MouseOption.position