Skip to main content
Primary mouse click. Provide exactly one of on, css, coords, or x/y. The simplified form takes a single string description.

Parameters

ParameterTypeRequiredDescription
onstringNoNatural-language description of the click target.
cssstringNoCSS selector for the target. Use instead of the description key.
coordsstring | { x, y }NoAbsolute viewport coordinates. Either an x, y string (e.g. 120, 40) or a { x, y } object.
xnumber | stringNoX coordinate. Must be provided together with y.
ynumber | stringNoY coordinate. Must be provided together with x.
forcebooleanNoForce the action even when the element is not actionable.
iframestringNoURL or URL pattern of the iframe that contains the target element.
offsetstring | { x, y }NoPixel offset from the resolved target. Either an x, y string or a { x, y } object.
timesnumberNoNumber of times to click. Must be >= 1.
waitForDownloadbooleanNoWait for a download to start after the click.
delaynumberNoMilliseconds to hold between mousedown and mouseup.
downloadTimeoutnumberNoMaximum time in milliseconds to wait for a download.
saveAsstringNoName of the variable to write this step’s return value to.
retriesnumberNoNumber of times to retry the step on failure before failing the test.
skippedbooleanNoSkip this step at execution time.

Shorthand

Target description as a single string.
- click: the GB regression test menu item

Examples

- click:
    on: "the module card showing 'Module: testing-copilot'"
    waitForDownload: false
    retries: 2
- click:
    on: the button to download as zip
    waitForDownload: true
    saveAs: DOWNLOADED_FILE
- click:
    css: '[data-pendo-tracking="invoice-workspace-menu"]'
- click:
    on: the click here button
    iframe: https://bit.ly/3re1ic9
- click:
    coords: 0, 0
- click:
    on: the lucide save button in the top toolbar even if it is disabled
    force: true