externalPress

Instructs an actor who has the ability to BrowseTheWeb to send a key press or a sequence of keys to a Web element.

Note: On macOS, some keyboard shortcuts might not work with the devtools protocol.

For example:

• to copy, instead of Key.Meta+C, use Key.Control+Key.Insert
• to cut, instead of Key.Meta+X, use Key.Control+Key.Delete
• to paste, instead of Key.Meta+V, use Key.Shift+Key.Insert

Example widget

<form>
  <input type="text" name="example" id="example" />
</form>

Lean Page Object describing the widget

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

class Form {
  static exampleInput = () =>
    PageElement.located(By.id('example'))
      .describedAs('example input')
}

Pressing keys

import { actorCalled } from '@serenity-js/core'
import { Key, Press, Value } from '@serenity-js/web'
import { Ensure, equals } from '@serenity-js/assertions'

await actorCalled('Priyanka')
  .attemptsTo(
    Press.the('H', 'i', '!', Key.ENTER).in(Form.exampleInput()),
    Ensure.that(Value.of(Form.exampleInput), equals('Hi!')),
  )

Learn more

• Key
• BrowseTheWeb
• PageElement

Hierarchy

• PageElementInteraction
  • Press

Index

Methods

• the
• instantiationLocation
• describedBy
• toString
• in
• performAs

Methods

staticexternalthe

• the(...keys: Answerable<string | string[] | Key | Key[]>[]): Activity & { in: (field: Answerable<PageElement<any>>) => Interaction }

• Instantiates an interaction that instructs the actor to press a sequence of keys,

  When no field is specified, the key sequence will be sent to the currently focused element, and if no element is focused - to the document.body to handle.

  ---

  Parameters

  • externalrest...keys: Answerable<string | string[] | Key | Key[]>[]

    A sequence of one or more keys to press

  Returns Activity & { in: (field: Answerable<PageElement<any>>) => 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

externalin

• in(field: Answerable<PageElement<any>>): Interaction

• Send the key sequence to a specific element.

  ---

  Parameters

  • externalfield: Answerable<PageElement<any>>

  Returns Interaction

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>