Skip to main content
Asserts a condition on the element’s type/class name. 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
onstringYesTarget description or percent pair.
valuestringSometimesValue to compare against. Required for every condition except *Exists and *DoesNotExist.
timeoutnumberNoMilliseconds to wait for the condition to hold.
saveAsstringNoVariable to store this step’s return value on env.<name>.
retriesnumberNoTimes to retry the step on failure before failing the test.
skippedbooleanNoSkip this step at execution time.

​
Examples

- checkElementNameEquals:
    on: the submit button
    value: XCUIElementTypeButton # iOS element type

- checkElementNameStartsWith:
    on: the username field
    value: android.widget.EditText # Android class name

​
Notes

Aliases supported by this family:
Alias
checkElementNameExists
checkElementNameDoesNotExist
checkElementNameContains
checkElementNameDoesNotContain
checkElementNameEquals
checkElementNameDoesNotEqual
checkElementNameStartsWith
checkElementNameDoesNotStartWith