import {Click} from '@serenity-js/webdriverio/lib/screenplay/interactions'
public class | source

Click

Instructs the Actor to click on a given Web element.

Extends:

Examples:

Example widget
 <form>
   <input type="text" name="example" id="example" />
 </form>
Lean Page Object describing the widget
 import { by, Target } from '@serenity-js/webdriverio';

 class Form {
     static exampleInput = Target.the('example input')
         .located(by.id('example'));
 }
Clicking on an element
 import { actorCalled } from '@serenity-js/core';
 import { BrowseTheWeb, Click, isSelected } from '@serenity-js/webdriverio';
 import { Ensure } from '@serenity-js/assertions';

 actorCalled('Chloé')
     .whoCan(BrowseTheWeb.using(browser))
     .attemptsTo(
         Click.on(Form.exampleInput),
         Ensure.that(Form.exampleInput, isSelected()),
     );

Tests:

Static Method Summary

Static Public Methods
public static

on(target: Answerable<Element<'async'>>): Interaction

Instantiates this Interaction.

Constructor Summary

Public Constructor
public

constructor(target: Answerable<Element<'async'>>)

Method Summary

Public Methods
public

async performAs(actor: UsesAbilities & AnswersQuestions): PromiseLike<void>

Makes the provided Actor perform this Interaction.

Inherited Summary

From class WebElementInteraction
public

toString(): string

Generates a description to be used when reporting this Activity.

protected

async resolve(actor: AnswersQuestions, element: Answerable<Element<'async'>>): Promise<Element<'async'>>

Returns the resolved Element, or throws a LogicError if the element is undefined.

Static Public Methods

public static on(target: Answerable<Element<'async'>>): Interaction source

Instantiates this Interaction.

Params:

NameTypeAttributeDescription
target Answerable<Element<'async'>>

The element to be clicked on

Returns:

Interaction

Public Constructors

public constructor(target: Answerable<Element<'async'>>) source

Params:

NameTypeAttributeDescription
target Answerable<Element<'async'>>

The element to be clicked on

Public Methods

public async performAs(actor: UsesAbilities & AnswersQuestions): PromiseLike<void> source

Makes the provided Actor perform this Interaction.

Params:

NameTypeAttributeDescription
actor UsesAbilities & AnswersQuestions

An Actor to perform this Interaction

Returns:

PromiseLike<void>