API Reference

adapter

summary
public

WebdriverIO configuration object with Serenity/JS-specific additions.

expectations

summary
public

F isActive(): Expectation<boolean, Element<'async'>>

Expectation that the element is active (has focus).

public

F isClickable(): Expectation<boolean, Element<'async'>>

Expectation that an element is clickable, which means:

  • it exists
  • it is visible
  • it is within viewport (if not, try to scroll to it)
  • its center is not overlapped with another element
  • it is not disabled otherwise return false.
public

F isEnabled(): Expectation<boolean, Element<'async'>>

Expectation that the element is enabled.

public

F isPresent(): Expectation<boolean, Element<'async'>>

Expectation that the element is present in the DOM of a page.

public

F isSelected(): Expectation<boolean, Element<'async'>>

Expectation that an <option> or <input> element of type checkbox or radio is currently selected.

public

F isVisible(): Expectation<boolean, Element<'async'>>

Expectation that the element is present in the DOM of the page and visible.

input

summary
public

C Key

Represents pressable keys that aren't text to be used with Press.

Note that modifier like Shift, Alt and Meta (a.k.a. Command on Mac) will stay pressed

screenplay/abilities

summary
public
this class is experimental.

An Ability that enables the Actor to interact with Web apps using WebdriverIO.

screenplay/interactions

summary
public

C Clear

Instructs the Actor to clear the value of a form input.

public

C Click

Instructs the Actor to click on a given Web element.

public

Instructs the Actor to perform a double-click on a given Web element.

public

C Enter

Instructs the Actor to enter a value into a form input field.

public

Instructs the Actor to execute a script within the context of the current browser window.

public abstract

Allows for a script to be executed to be parametrised.

public

C Hover

Instructs the Actor to hover the mouse pointer over a given Web element.

public

Allows the Actor to navigate to a specific destination, as well as back and forth in the browser history, or reload the current page.

public

C Press

Instructs the Actor to send a key press or a sequence of keys to a Web element.

public

Instructs the Actor to perfom a right click on a given Web element.

public

C Scroll

Instructs the Actor to scroll until a given Web element comes into view.

public

C Wait

Instructs the Actor to wait before proceeding either for a set Duration or until a given Expectation is met.

public

A base class for WebdriverIO-specific interactions

public

Fluent interface to make the instantiation of the Interaction to Enter more readable.

public

Fluent interface to make the instantiation of the Interaction to Press more readable.

public

Fluent interface to make the instantiation of the Interaction to Wait more readable.

screenplay/questions

summary
public

Returns the value of the given HTML attribute of a given WebElement, represented by Answerable<Element>

public

Resolves to an array of CSS classes of a given WebElement, represented by Answerable<Element>.

public

Returns the result of last script executed via ExecuteScript

public

C Text

Resolves to the visible (i.e.

public

C Value

Returns the value attribute of a given WebElement, represented by Answerable<Element>

public
public

Adapts ElementArray so that it can be used with List.

public

Represents a way to retrieve one and multiple Web elements using a given strategy.

public

Locator factory.

public

C Target

Provides a convenient way to retrieve a single web element or multiple web elements, so that they can be used with Serenity/JS Interactions.

public

You probably don't want to use this class directly. See Target instead.

public

You probably don't want to use this class directly. See Target instead.

public

You probably don't want to use this class directly. See Target instead.

public

You probably don't want to use this class directly. See Target instead.

public

Fluent interface to make the instantiation of the Question about a nested Target more readable.

public

Fluent interface to make the instantiation of the Question about a Target more readable.

public
public

T TargetList: List<ElementArrayListAdapter, Promise<Element<'async'>>, Promise<ElementArray>>

A type alias representing a List of WebdriverIO Web elements.

stage/crew/photographer

summary
public

The Photographer is a StageCrewMember who takes screenshots of the web browser that the Actor in the spotlight is using.

stage/crew/photographer/strategies

summary
public abstract

Configures the Photographer to take photos (a.k.a.

public

Configures the Photographer to take photos (a.k.a.

public

Configures the Photographer to take photos (a.k.a.

public

Configures the Photographer to take photos (a.k.a.