Performs a tap (touch click) on an element. Primarily for touch-enabled devices or emulation. The element is identified using one of the provided selector strategies. Example: tap(selector: "button.mobile-menu") Returns true if the tap action was successful.

Definition

tap(
  selector: String
  text: String
  role: ARIARole
  label: String
  placeholder: String
  altText: String
  title: String
  testId: String
  filter: ElementFilterOptions
  options: TapOptions
): Boolean!

Arguments

selector

String The CSS selector for the element. Example: "#username" for <input id="username" />.

text

String Finds an element by its text content. Example: "Login" for <button>Login</button>.

role

ARIARole Finds an element by its ARIA role. Example: "button" for <div role="button">Submit</div>.

label

String Finds an element by its ARIA label. Example: "Search button" for <button aria-label="Search button"><svg/></button>.

placeholder

String Finds an element by its placeholder text. Example: "Enter your email" for <input placeholder="Enter your email" />.

altText

String Finds an element by its image alt text. Example: "Company logo" for <img alt="Company logo" src="..." />.

title

String Finds an element by its title attribute. Example: "Close dialog" for <span title="Close dialog">X</span>.

testId

String Finds an element by its data-testid attribute. Example: "submit-button" for <button data-testid="submit-button">Go</button>.

filter

ElementFilterOptions Advanced filtering options for the element.

options

TapOptions Options for the tap action, such as modifiers, position, or timeout.

Returns

Boolean! The Boolean scalar type represents true or false.