externalScroll

Instructs an actor who has the ability to BrowseTheWeb to scroll until a given PageElement comes into view.

Example widget

<!--
  an element somewhere at the bottom of the page,
  outside of the visible area
-->
<input type="submit" id="submit" />

Lean Page Object describing the widget

import { By, PageElement } from '@serenity-js/web'

class Form {
  static submitButton = () => {
    PageElement.located(By.id('submit'))
      .describedAs('submit button')
}

Scrolling to element

import { actorCalled } from '@serenity-js/core'
import { Ensure } from '@serenity-js/assertions'
import { Scroll, isVisible } from '@serenity-js/web'

await actorCalled('Sara')
  .attemptsTo(
    Scroll.to(Form.submitButton()),
    Ensure.that(Form.submitButton(), isVisible()),
  )

Learn more

• BrowseTheWeb
• PageElement

Hierarchy

• Interaction
  • Scroll

Index

Methods

• to
• instantiationLocation
• describedBy
• toString
• performAs

Methods

staticexternalto

• to(pageElement: Answerable<PageElement<any>>): Scroll

• Instantiates this Interaction.

  ---

  Parameters

  • externalpageElement: Answerable<PageElement<any>>

    The element to scroll to

  Returns Scroll

externalinstantiationLocation

• instantiationLocation(): FileSystemLocation

• Inherited from Interaction.instantiationLocation

  Returns the location where this Activity was instantiated.

  ---

  Returns FileSystemLocation

externaldescribedBy

• describedBy(actor: AnswersQuestions & UsesAbilities & { name: string }): Promise<string>

• Inherited from Interaction.describedBy

  Resolves the description of this object in the context of the provided actor.

  ---

  Parameters

  • externalactor: AnswersQuestions & UsesAbilities & { name: string }

  Returns Promise<string>

externaltoString

• toString(): string

• Inherited from Interaction.toString

  Returns a human-readable description of this object.

  ---

  Returns string

externalperformAs

• performAs(actor: UsesAbilities & AnswersQuestions): Promise<void>

• Overrides Interaction.performAs

  @inheritDoc

  ---

  Parameters

  • externalactor: UsesAbilities & AnswersQuestions

  Returns Promise<void>