Class Click

Click on an element specified by a locator string.

Hierarchy

Action
- Click

Index

Properties

abilityAlias? callStack?

Methods - Factory

Methods - Other

addToCallStack setCallStackInitializeCalledWith withAbilityAlias

Methods - called internally

Properties

`Optional` abilityAlias

abilityAlias?: string

`Optional` callStack

callStack?: CallStackInfo[]

Methods - Factory

`Static` on

on(locator, options?): Click
specify which element should be clicked on
Parameters
- locator: Locator
  the string representing the locator.
- Optional options: ClickActionOptions
  (optional) options for the click action.
Returns Click
new Click instance
Example
simple call with just locator
```
Click.on(
  page.locator('myLocator')
);
```
with options
```
Click.on(
  page.locator('myLocator'),
  { timeout: 3000 }
);
```
- Defined in src/web/actions/Click.ts:54

Methods - Other

addToCallStack

addToCallStack(entry): void
Parameters
- entry: CallStackInfo
Returns void
Inherited from Action.addToCallStack
- Defined in node_modules/@testla/screenplay/lib/templates/UsingLogging.d.ts:6

setCallStackInitializeCalledWith

setCallStackInitializeCalledWith(calledWith): void
Parameters
- calledWith: CallStackCalledWith
Returns void
Inherited from Action.setCallStackInitializeCalledWith
- Defined in node_modules/@testla/screenplay/lib/templates/UsingLogging.d.ts:5

withAbilityAlias

withAbilityAlias(alias): this
Set the alias which is used for an underlying ability
Parameters
- alias: undefined | string
  with which an ability was initialized
Returns this
current action
Inherited from Action.withAbilityAlias
- Defined in node_modules/@testla/screenplay/lib/templates/UsingAlias.d.ts:10

Methods - called internally

performAs

performAs(actor): Promise<void>
find the specified locator and click on it.
Parameters
- actor: Actor
  Actor performing this action
Returns Promise<void>
Returns after clicking the element
Overrides Action.performAs
- Defined in src/web/actions/Click.ts:28

Generated using TypeDoc