Skip to content

Lupa API Reference / commands/locator / DoubleClickOptions

Interface: DoubleClickOptions

Defined in: src/commands/locator.ts:281

Options for the double click action.

Extends

Properties

button?

optional button?: "right" | "left" | "middle"

Defined in: src/commands/locator.ts:285

Defaults to left.


delay?

optional delay?: number

Defined in: src/commands/locator.ts:290

Time to wait between mousedown and mouseup in milliseconds. Defaults to 0.


force?

optional force?: boolean

Defined in: src/commands/locator.ts:171

Whether to bypass the actionability checks. Defaults to false.

Inherited from

ForceOption.force


modifiers?

optional modifiers?: ("Alt" | "Control" | "ControlOrMeta" | "Meta" | "Shift")[]

Defined in: src/commands/locator.ts:205

Modifier keys to press. Ensures that only these modifiers are pressed during the operation, and then restores current modifiers back. If not specified, currently pressed modifiers are used. "ControlOrMeta" resolves to "Control" on Windows and Linux and to "Meta" on macOS.

Inherited from

ModifiersOption.modifiers


position?

optional position?: object

Defined in: src/commands/locator.ts:216

A point to use relative to the top-left corner of element padding box. If not specified, uses some visible point of the element.

x

x: number

X coordinate

y

y: number

Y coordinate

Inherited from

PositionOption.position


steps?

optional steps?: number

Defined in: src/commands/locator.ts:296

Defaults to 1. Sends n interpolated mousemove events to represent travel between Playwright's current cursor position and the provided destination. When set to 1, emits a single mousemove event at the destination location.


timeout?

optional timeout?: number

Defined in: src/commands/locator.ts:161

Maximum time in milliseconds. Defaults to 0 - no timeout. The default value can be changed via actionTimeout option in the config, or by using the browserContext.setDefaultTimeout(timeout) or page.setDefaultTimeout(timeout) methods.

Inherited from

TimeoutOption.timeout


trial?

optional trial?: boolean

Defined in: src/commands/locator.ts:193

When set, this method only performs the actionability checks and skips the action. Defaults to false. Useful to wait until the element is ready for the action without performing it.

Inherited from

TrialOption.trial