Menu

This is documentation for the next version of K6. For the latest stable release, go to the latest version.

Open source

dblclick(selector[, options])

Warning

Use locator-based locator.dblclick([options]) instead.

Double clicks on an element matching the provided selector.

ParameterTypeDefaultDescription
selectorstring''A selector to search for an element. The first element will be used if multiple elements match the selector.
optionsobjectnull
options.buttonstringleftThe mouse button (left, middle or right) to use during the action.
options.delaynumber0Milliseconds to wait between mousedown and mouseup.
options.forcebooleanfalseBypasses the actionability checks (visible, stable, enabled) if set to true.
options.modifiersstring[]nullAlt, Control, Meta or Shift modifiers keys pressed during the action. If not specified, currently pressed modifiers are used.
options.noWaitAfterbooleanfalseIf set to true and a navigation occurs from performing this action, it will not wait for it to complete.
options.positionobjectnullA point to use relative to the top left corner of the element. If not supplied, a visible point of the element is used.
options.position.xnumber0The x coordinate.
options.position.ynumber0The y coordinate.
options.strictbooleanfalseWhen true, the call requires selector to resolve to a single element. If given selector resolves to more than one element, the call throws an exception.
options.timeoutnumber30000Maximum time in milliseconds. Pass 0 to disable the timeout. Default is overridden by the setDefaultTimeout option on BrowserContext or Page.
options.trialbooleanfalseSetting this to true will perform the actionability checks without performing the action.

Returns

TypeDescription
Promise<void>A Promise that fulfills when the double click action is finished.