@serenity-js/web
Version:
Serenity/JS Screenplay Pattern library offering a flexible, web driver-agnostic approach for interacting with web-based user interfaces and components, suitable for various testing contexts
216 lines • 8.51 kB
TypeScript
import type { Answerable, QuestionAdapter } from '@serenity-js/core';
import type { PageElement } from '../models';
/**
* Uses the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to retrieve
* options and values selected in a
* [HTML `<select>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select).
*
* ## Learn more
* - [`Select`](https://serenity-js.org/api/web/class/Select/)
* - [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/)
* - [`QuestionAdapter`](https://serenity-js.org/api/core/#QuestionAdapter)
* - [`Question`](https://serenity-js.org/api/core/class/Question/)
*
* @group Questions
*/
export declare class Selected {
/**
* Uses the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to retrieve
* a single [option](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
* selected in an [HTML `<select>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select).
*
* #### Example widget
*
* ```html
* <select multiple data-test='countries'>
* <option value='UK'>United Kingdom</option>
* <option value='PL'>Poland</option>
* <option value='US'>United States</option>
* </select>
* ```
*
* #### Lean Page Object describing the widget
*
* ```ts
* import { By, PageElement } from '@serenity-js/web'
*
* class Countries {
* static dropdown = () =>
* PageElement.located(By.css('[data-test="countries"]'))
* .describedAs('countries dropdown');
* }
* ```
*
* #### Retrieving the selected value
*
* ```ts
* import { actorCalled } from '@serenity-js/core'
* import { Select, Selected } from '@serenity-js/web'
* import { Ensure, equals } from '@serenity-js/assertions'
*
* await actorCalled('Nick')
* .whoCan(BrowseTheWeb.using(protractor.browser))
* .attemptsTo(
* Select.value('UK').from(Countries.dropdown),
* Ensure.that(Selected.valueOf(Countries.dropdown), equals('UK')),
* )
* ```
*
* #### Learn more
* - [`Select.value`](https://serenity-js.org/api/web/class/Select/#value)
*
* @param pageElement
* A [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) identifying the `<select>` element of interest
*/
static valueOf(pageElement: Answerable<PageElement>): QuestionAdapter<string>;
/**
* Uses the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to retrieve
* values of [options](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/option)
* selected in an [HTML `<select multiple>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select#attr-multiple)
*
* #### Example widget
*
* ```html
* <select multiple data-test='countries'>
* <option value='UK'>United Kingdom</option>
* <option value='PL'>Poland</option>
* <option value='US'>United States</option>
* </select>
* ```
*
* #### Lean Page Object describing the widget
*
* ```ts
* import { By, PageElement } from '@serenity-js/web'
*
* class Countries {
* static dropdown = () =>
* PageElement.located(By.css('[data-test="countries"]'))
* .describedAs('countries dropdown')
* }
* ```
*
* #### Retrieving the selected value
*
* ```ts
* import { actorCalled } from '@serenity-js/core'
* import { Select, Selected } from '@serenity-js/web'
* import { Ensure, equals } from '@serenity-js/assertions'
*
* await actorCalled('Nick')
* .whoCan(BrowseTheWeb.using(protractor.browser))
* .attemptsTo(
* Select.values('UK').from(Countries.dropdown),
* Ensure.that(Selected.valuesOf(Countries.dropdown), equals([ 'UK' ])),
* )
* ```
*
* #### Learn more
* - [`Select.values`](https://serenity-js.org/api/web/class/Select/#values)
*
* @param pageElement
* A [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) identifying the `<select>` element of interest
*/
static valuesOf(pageElement: Answerable<PageElement>): QuestionAdapter<Array<string>>;
/**
* Uses the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to retrieve
* a single option selected in an [HTML `<select>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select#attr-multiple)
*
* #### Example widget
*
* ```html
* <select multiple data-test='countries'>
* <option value='UK'>United Kingdom</option>
* <option value='PL'>Poland</option>
* <option value='US'>United States</option>
* </select>
* ```
*
* #### Lean Page Object describing the widget
*
* ```ts
* import { By, PageElement } from '@serenity-js/web'
*
* class Countries {
* static dropdown = () =>
* PageElement.located(By.css('[data-test="countries"]'))
* .describedAs('countries dropdown')
* }
* ```
*
* #### Retrieving the selected value
*
* ```ts
* import { actorCalled } from '@serenity-js/core'
* import { Select, Selected } from '@serenity-js/web'
* import { Ensure, equals } from '@serenity-js/assertions'
*
* await actorCalled('Nick')
* .attemptsTo(
* Select.option('Poland').from(Countries.dropdown),
* Ensure.that(
* Selected.optionIn(Countries.dropdown),
* equals('Poland')
* ),
* )
* ```
*
* #### Learn more
* - [`Select.option`](https://serenity-js.org/api/web/class/Select/#option)
*
* @param pageElement
* A [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) identifying the `<select>` element of interest
*/
static optionIn(pageElement: Answerable<PageElement>): QuestionAdapter<string>;
/**
* Uses the [actor's](https://serenity-js.org/api/core/class/Actor/) [ability](https://serenity-js.org/api/core/class/Ability/) to [`BrowseTheWeb`](https://serenity-js.org/api/web/class/BrowseTheWeb/) to retrieve
* options selected in an [HTML `<select multiple>` element](https://developer.mozilla.org/en-US/docs/Web/HTML/Element/select#attr-multiple)
*
* #### Example widget
*
* ```html
* <select multiple data-test='countries'>
* <option value='UK'>United Kingdom</option>
* <option value='PL'>Poland</option>
* <option value='US'>United States</option>
* </select>
* ```
*
* #### Lean Page Object describing the widget
*
* ```ts
* import { By, PageElement } from '@serenity-js/web'
*
* class Countries {
* static dropdown = () =>
* PageElement.located(By.css('[data-test="countries"]'))
* .describedAs('countries dropdown')
* }
* ```
*
* #### Retrieving the selected value
*
* ```ts
* import { actorCalled } from '@serenity-js/core'
* import { Select, Selected } from '@serenity-js/web'
* import { Ensure, equals } from '@serenity-js/assertions'
*
* await actorCalled('Nick')
* .attemptsTo(
* Select.options('Poland', 'United States').from(Countries.dropdown),
* Ensure.that(
* Selected.optionsIn(Countries.dropdown),
* equals([ 'Poland', 'United States' ])
* ),
* )
* ```
*
* #### Learn more
* - [`Select.options`](https://serenity-js.org/api/web/class/Select/#options)
*
* @param pageElement
* A [`PageElement`](https://serenity-js.org/api/web/class/PageElement/) identifying the `<select>` element of interest
*/
static optionsIn(pageElement: Answerable<PageElement>): QuestionAdapter<Array<string>>;
}
//# sourceMappingURL=Selected.d.ts.map