Skip to main content

externalabstractPageElement <Native_Element_Type>

Uses the actor's ability to BrowseTheWeb to identify a single Web element located by Selector.

Learn more

Implements

Index

Constructors

Properties

Methods

Constructors

externalconstructor

  • new PageElement<Native_Element_Type>(locator: Locator<Native_Element_Type, any>): PageElement<Native_Element_Type>

  • Type parameters

    • Native_Element_Type = any

    Parameters

    • externallocator: Locator<Native_Element_Type, any>

    Returns PageElement<Native_Element_Type>

Properties

publicexternalreadonlylocator

locator: Locator<Native_Element_Type, any>

Methods

staticexternalfrom

staticexternallocated

staticexternalof

staticexternalhtml

  • A static method producing a MetaQuestion that can be used with PageElements.eachMappedTo method to extract the HTML of each element in a collection.

    Example

    import { actorCalled, Log } from '@serenity-js/core'
    import { Navigate, PageElement, By, Text } from '@serenity-js/web'
    import { includes } from '@serenity-js/assertions'

    await actorCalled('Debbie').attemptsTo(
      Navigate.to('https://serenity-js.org'),

      Log.the(
        PageElements.located(By.css('a'))
          .where(Text, includes('modular'))
          .eachMappedTo(PageElement.html())
      ),
    )

    Type parameters

    • NET

    Returns MetaQuestion<PageElement<NET>, QuestionAdapter<string>>

externalabstractof

  • Locates a child element that:

    • matches the given selector
    • is located within the parentElement

    Parameters

    • externalparentElement: PageElement<Native_Element_Type>

    Returns PageElement<Native_Element_Type>

externalabstractclosestTo

  • Traverses the element and its parents, heading toward the document root, until it finds a parent PageElement that matches its associated CSS selector.

    Example

    <div class="form-entry">
        <input id="username" />
        <ul class="warnings">
            <li>Username should be an email address</li>
        </ul>
    </div>
    class Username {
      static field = () =>
        PageElement.located(By.id('username'))
          .describedAs('username field')

      private static container = () =>
        PageElement.located(By.css('.form-entry'))
          .describedAs('form entry container')

      static warnings = () =>
        PageElements.located(By.css('ul.warnings li'))
          .describedAs('warnings')
          .of(
            Username.container().closestTo(Username.field())
          )
    }

    This method relies on Element: closest() API, and so is only compatible with locating parent elements specified using the following CSS selectors:

    Parameters

    Returns PageElement<Native_Element_Type>

    Learn more

externalnativeElement

  • nativeElement(): Promise<Native_Element_Type>

  • An "escape hatch" providing access to the integration tool-specific implementation of a Web element.

    Returns Promise<Native_Element_Type>

externaltoString

  • toString(): string

  • Returns string

externalabstractenterValue

  • enterValue(value: string | number | (string | number)[]): Promise<void>

  • Parameters

    • externalvalue: string | number | (string | number)[]

    Returns Promise<void>

externalabstractclearValue

  • clearValue(): Promise<void>

  • Returns Promise<void>

externalabstractclick

  • click(): Promise<void>

  • Returns Promise<void>

externalabstractdoubleClick

  • doubleClick(): Promise<void>

  • Returns Promise<void>

externalabstractscrollIntoView

  • scrollIntoView(): Promise<void>

  • Returns Promise<void>

externalabstracthoverOver

  • hoverOver(): Promise<void>

  • Returns Promise<void>

externalabstractrightClick

  • rightClick(): Promise<void>

  • Returns Promise<void>

externalabstractselectOptions

  • Parameters

    Returns Promise<void>

externalabstractselectedOptions

externalabstractattribute

  • attribute(name: string): Promise<string>

  • Parameters

    • externalname: string

    Returns Promise<string>

externalabstracttext

  • text(): Promise<string>

  • Returns Promise<string>

externalabstractvalue

  • value(): Promise<string>

  • Returns Promise<string>

externalabstracthtml

  • html(): Promise<string>

  • An instance method that resolves to the value of the outerHTML property of the underlying element.

    Example

    import { actorCalled, Log } from '@serenity-js/core'
    import { Navigate, PageElement, By } from '@serenity-js/web'

    await actorCalled('Debbie').attemptsTo(
      Navigate.to('https://serenity-js.org'),

      Log.the(
        PageElement.located(By.css('h1')).html()
      ),
    )

    Returns Promise<string>

externalabstractswitchTo

  • When the element represents an iframe, calling this method switches the current browsing context to the given iframe context.

    When used with other types of Web Element, calling this method will have the same result as calling Element.focus().

    Returns Promise<SwitchableOrigin>

    Returns an object that allows the caller to switch back to the previous context if needed.

    Learn more

externalabstractisActive

  • isActive(): Promise<boolean>

  • Resolves to true when the underlying element has focus. Otherwise, resolves to false.

    Returns Promise<boolean>

externalabstractisClickable

  • isClickable(): Promise<boolean>

  • Resolves to true when the underlying element can be clicked on. Otherwise, resolves to false.

    Please refer to test integration tool-specific documentation for details.

    Returns Promise<boolean>

externalabstractisEnabled

  • isEnabled(): Promise<boolean>

  • Resolves to true when the underlying element is not explicitly disabled

    Please refer to test integration tool-specific documentation for details.

    Returns Promise<boolean>

externalisPresent

  • isPresent(): Promise<boolean>

  • Returns a Promise that resolves to true when the element is present in the Document Object Model (DOM), false otherwise.

    Returns Promise<boolean>

externalabstractisSelected

  • isSelected(): Promise<boolean>

  • Resolves to true when the underlying element:

    Otherwise, resolves to false.

    Returns Promise<boolean>

externalabstractisVisible

  • isVisible(): Promise<boolean>

  • Resolves to true when the underlying element:

    • is not hidden, so doesn't have CSS style like display: none, visibility: hidden or opacity: 0
    • is within the browser viewport
    • doesn't have its centre covered by other elements

    Otherwise, resolves to false.

    Returns Promise<boolean>