selectText

Selects text within an input field, textarea, or contenteditable element. The element is identified using one of the provided selector strategies. If no range is specified, all text is selected. Example: selectText(selector: "#myInput") Returns true if the text was successfully selected.

​

Definition

selectText(
  selector: String
  text: String
  role: String
  label: String
  placeholder: String
  altText: String
  title: String
  testId: String
  filter: ElementFilterOptions
  options: SelectTextOptions
): 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: String

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: SelectTextOptions

Options for the text selection, such as forcing the action or setting a timeout. Note: Specific range selection is not exposed here; it typically selects all text in the matched element.

​

Returns

Boolean!

The Boolean scalar type represents true or false.