externalHover

Instructs an actor who has the ability to BrowseTheWeb to hover the mouse pointer over a given PageElement.

Example widget

 <a data-test="example-link"
     class="off"
     onmouseover="this.className='on';"
     onmouseout="this.className='off';"
     href="/">hover over me</a>

Lean Page Object describing the widget

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

class Example {
  static link = () =>
    PageElement.located(By.css('[data-test="example-link"]'))
      .describedAs('example link')
 }

Hovering over an element

import { actorCalled } from '@serenity-js/core'
import { Hover, CssClasses } from '@serenity-js/web'
import { Ensure, equals } from '@serenity-js/assertions'

await actorCalled('Hank')
  .whoCan(BrowseTheWeb.using(browser))
  .attemptsTo(
     Ensure.that(CssClasses.of(Example.link()), equals([ 'off' ])),

    Hover.over(Example.link),
    Ensure.that(CssClasses.of(Example.link()), equals([ 'on' ])),
  )

Learn more

• BrowseTheWeb
• PageElement

Hierarchy

• PageElementInteraction
  • Hover

Index

Methods

• over
• instantiationLocation
• describedBy
• toString
• performAs

Methods

staticexternalover

• over(pageElement: Answerable<PageElement<any>>): Interaction

• Instantiates this Interaction

  ---

  Parameters

  • externalpageElement: Answerable<PageElement<any>>

    The element to be hovered over

  Returns Interaction

externalinstantiationLocation

• instantiationLocation(): FileSystemLocation

• Inherited from PageElementInteraction.instantiationLocation

  Returns the location where this Activity was instantiated.

  ---

  Returns FileSystemLocation

externaldescribedBy

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

• Inherited from PageElementInteraction.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 PageElementInteraction.toString

  Returns a human-readable description of this object.

  ---

  Returns string

externalperformAs

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

• Overrides PageElementInteraction.performAs

  Instructs the provided Actor to perform this Interaction.

  Learn more

  • Actor
  • PerformsActivities
  • UsesAbilities
  • AnswersQuestions

  ---

  Parameters

  • externalactor: UsesAbilities & AnswersQuestions

  Returns Promise<void>