Class Focus

Focus on an element specified by a locator string.

Hierarchy

  • Action
    • Focus

Properties

abilityAlias? callStack?

Methods - Factory

on

Methods - Other

addToCallStack setCallStackInitializeCalledWith withAbilityAlias

Methods - called internally

performAs

Properties

Optional abilityAlias

abilityAlias?: string

Optional callStack

callStack?: CallStackInfo[]

Methods - Factory

Static on

  • on(locator, options?): Focus

  • specify which element should be focused on

    Parameters

    • locator: Locator

      the string representing the locator.

    • Optional options: {
          timeout?: number;
      }

      (optional) options for the focus action.

      • Optional timeout?: number

    Returns Focus

    new Focus instance

    Example

    simple call with just locator

    Click.on(
      page.locator('myLocator')
    );

    with options

    Click.on(
      page.locator('myLocator'),
      { timeout: 3000 }
    );

Methods - Other

addToCallStack

  • addToCallStack(entry): void

  • Parameters

    • entry: CallStackInfo

    Returns void

setCallStackInitializeCalledWith

  • setCallStackInitializeCalledWith(calledWith): void

  • Parameters

    • calledWith: CallStackCalledWith

    Returns void

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

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 focusing the element

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc