Skip to main content
Asserts a condition on the element itself. Each alias is its own single-key command. There is no separate condition or negated field. The positive and negative variants map directly to the table below.

​
Parameters

ParameterTypeRequiredDescription
elementstringNoNatural-language description of the target. Use exactly one of element, css, coords, or x/y.
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.
timeoutnumberNoMaximum time in milliseconds to wait for the condition to hold.
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

When the alias takes no extra fields (e.g. Exists, Visible), the value can be a single target string. 
- checkElementVisible: Save button

​
Examples

- checkElementVisible: the 'view code' button

- checkElementVisible:
    element: the Delayed action button
    timeout: 16000 # poll for up to 16s before failing

- checkElementVisible:
    element: the paragraph with the text about clicking the button from iframe 1
    iframe: https://bit.ly/38erOdQ # scope the lookup to this iframe

- checkElementEnabled:
    element: api key link
    timeout: 30000

- checkElementDoesNotExist:
    css: "#processing" # target by CSS selector instead of a description

- checkElementNotVisible:
    element: "{{ env.NON_PLAN }} column in the pricing table"
    DANGEROUS_FORCE_DYNAMIC: true # re-evaluate every run, skipping the step cache

- checkElementFocused: username input

- checkElementEditable: enabled input

​
Notes

Aliases supported by this family:
Alias
checkElementExists
checkElementDoesNotExist
checkElementVisible
checkElementNotVisible
checkElementEnabled
checkElementNotEnabled
checkElementEditable
checkElementNotEditable
checkElementFocused
checkElementNotFocused