Attribute

Uses the actor’s ability to BrowseTheWeb to retrieve the value of the specified HTML attribute of a given PageElement.

Example widget

<ul id="shopping-list" data-items-left="2">
  <li data-state="bought">Coffee<li>
  <li data-state="buy">Honey<li>
  <li data-state="buy">Chocolate<li>
</ul>

Retrieve an HTML attribute of a given PageElement

 import { actorCalled } from '@serenity-js/core'
 import { Ensure, equals } from '@serenity-js/assertions'
 import { Attribute, By, PageElement } from '@serenity-js/web'

 const shoppingList = () =>
   PageElement.located(By.id('shopping-list'))
     .describedAs('shopping list')

await actorCalled('Lisa')
  .attemptsTo(
    Ensure.that(
      Attribute.called('data-items-left').of(shoppingList()),
      equals('2')
    ),
  )

Using Attribute as QuestionAdapter

import { actorCalled } from '@serenity-js/core'
import { Ensure, equals } from '@serenity-js/assertions'
import { Attribute, By, PageElement } from '@serenity-js/web'

const shoppingList = () =>
  PageElement.located(By.css('#shopping-list'))
    .describedAs('shopping list')

await actorCalled('Lisa')
  .attemptsTo(
    Ensure.that(
      Attribute.called('id').of(shoppingList()).toLocaleUpperCase(),
      equals('SHOPPING-LIST')
    ),
)

Using as filter in Page Element Query Language

import { actorCalled } from '@serenity-js/core'
import { Ensure, includes } from '@serenity-js/assertions'
import { Attribute, By, PageElements } from '@serenity-js/web'

class ShoppingList {
  static items = () =>
    PageElements.located(By.css('#shopping-list li'))
      .describedAs('items')

  static outstandingItems = () =>
    ShoppingList.items()
      .where(
        Attribute.called('data-state'),
        includes('buy')
      )
}

await actorCalled('Lisa')
.whoCan(BrowseTheWebWithWebdriverIO.using(browser))
.attemptsTo(
  Ensure.that(
    Text.ofAll(ShoppingList.outstandingItems()),
    equals([ 'Honey', 'Chocolate' ])
  ),
)

Learn more

• BrowseTheWeb
• MetaQuestion
• QuestionAdapter
• Question

Hierarchy

• Question<Promise<string>>
  • Attribute

Implements

• MetaQuestion<PageElement, Question<Promise<string>>>

Index

Methods

• called
• as
• of
• answeredBy
• describedAs
• toString

Methods

staticcalled

• called(name: Answerable<string>): Attribute

• Instantiates a Question that uses the actor’s ability to BrowseTheWeb to retrieve the value of the specified HTML attribute of a given PageElement.

  ---

  Parameters

  • name: Answerable<string>

    The name of the attribute to retrieve

  Returns Attribute

as

• as<O>(mapping: (answer: string) => O | Promise<O>): QuestionAdapter<O>

• Inherited from Question.as

  Maps this question to one of a different type.

  Question.about('number returned as string', actor => '42')   // returns: QuestionAdapter<string>
    .as(Number)                                                // returns: QuestionAdapter<number>

  ---

  Type parameters

  • O

  Parameters

  • mapping: (answer: string) => O | Promise<O>

  Returns QuestionAdapter<O>

of

• of(pageElement: PageElement<any> | QuestionAdapter<PageElement<any>>): MetaQuestionAdapter<PageElement<any>, string>

• Implementation of MetaQuestion.of

  Resolves to the value of an HTML attribute of the pageElement.

  Learn more

  • MetaQuestion

  ---

  Parameters

  • pageElement: PageElement<any> | QuestionAdapter<PageElement<any>>

  Returns MetaQuestionAdapter<PageElement<any>, string>

answeredBy

• answeredBy(actor: AnswersQuestions & UsesAbilities): Promise<string>

• Overrides Question.answeredBy

  @inheritDoc

  ---

  Parameters

  • actor: AnswersQuestions & UsesAbilities

  Returns Promise<string>

describedAs

• describedAs(subject: string): Attribute

• Overrides Question.describedAs

  @inheritDoc

  ---

  Parameters

  • subject: string

  Returns Attribute

toString

• toString(): string

• Implementation of MetaQuestion.toString

  Overrides Question.toString

  @inheritDoc

  ---

  Returns string