Search for an element on the page that meets the provided ARIA role.
Element can be searched by using another element as the starting point.

You can pass some options to narrow the search:

  • selected - picks an element that has the area-selected attribute with true or false value.
  • checked - picks an element that has the area-checked attribute with true or false value.
  • pressed - picks an element that has the area-pressed attribute with true or false value.
  • current - picks an element that has the area-current attribute with true or false value.
  • level - picks an element that has the area-level attribute with true or false value. This option is suitable only for the heading role.
  • expanded - picks an element that has the area-expanded attribute with true or false value.

Usage

                    browser.element.findByRole(role, [options])
                

Example

export default {
  demoTest(browser: NightwatchAPI): void {
    const comboboxes = browser.element.findByRole('combobox');

    const headings = browser.element.findByRole('heading', { level: 2 });
  }
}

Parameters

Name Type description
role string
options
Optional
[object Object]

Returns

Type description
ScopedWebElement