Dropdown Field

Dropdown

While selecting a dropdown option, there is no need to open the list of values (like we are doing it manually). The value can be selected via select command, and you should be able to see the value being changed in the field.

It is possible to find a dropdown element by following attributes:

Name	Parameter(s)	Type	Description
dropdown	dataTestId	string	Searches for a dropdown by value of a Pega data-test-id attribute, same as dropdownByDataTestId
	container?	string
dropdownByDataTestId	dataTestId	string	Searches for a dropdown by value of a Pega data-test-id attribute, same as dropdown
	container?	string
dropdownById	id	string	Searches for a dropdown by value of an id attribute
	container?	string
dropdownByCss	css	string	Searches for a dropdown by a custom scc selector
dropdownByXPath	xpath	string	Searches for a dropdown by a custom xpath selector
	container?	string
dropdownBy	attributeName	string	Searches for a dropdown by an attribute name and value
	attributeValue	string
	container?	string

Main action functions

Name	Parameter(s)	Type	Description
select	value	string, {}?	Selects the value (by the value of an value attribute). It is possible to select the element by index (in options parameter)
	options?	{ index?: number, timeout?: number, interval?: number, retries?: number }
selectAndCheckTheValue	value	string	Selects the value (by the value of an value attribute) and checks if an option contains selected attribute
	options?	{ index?: number, timeout?: number, interval?: number, retries?: number }

Assertions

Name	Parameter(s)	Type	Description
shouldBeVisible	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }	Checks if the element exists and is visible
shouldExist	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }	Checks if the element exists
shouldNotBeVisible	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }	Checks if the element exists but is not visible
shouldNotExist	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }	Checks if the element does not exist
shouldHaveText	value	string	Checks if the element's inner text contains a given string
	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldNotHaveText	value	string	Checks if the element's inner text does not contain a given string
	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldHaveExactText	value	string	Checks if the element's inner text is equal to a given string
	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldNotHaveExactText	value	string	Checks if the element's inner text is not equal to a given string
	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldHaveValue	value	string	Checks if the element's value contains a given string
	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldNotHaveValue	value	string	Checks if the element's value does not contain a given string
	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldBeEnabled	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }	Checks if the element doesn't have a disabled attribute
shouldBeDisabled	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }	Checks if the element has a disabled attribute
shouldBeRequired	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }	Checks if the field is mandatory
shouldNotBeRequired	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }	Checks if the field is not mandatory
shouldHaveValidationType	validationType	string	Checks if the element's validation type is equal to a given one
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldNotHaveValidationType	validationType	string	Checks if the element's validation type is not equal to a given one
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldHaveSelectedItem	value	string	Checks if the element's value contains a given string
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldNotHaveSelectedItem	value	string	Checks if the element's value does not contain a given string
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldHaveAttributeSelected	value	string	Checks if the element's option has a selected attribute
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldNotHaveAttributeSelected	value	string	Checks if the element's option does not have a selected attribute
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldHaveSuggestedItems	values	string[]	Checks if the element's options contain the list of values (as values of the value attribute); order is not considered
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldNotHaveSuggestedItems	values	string[]	Checks if the element's options does not contain the list of values (as values of the value attribute)
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldOnlyHaveSuggestedItems	values	string[]	Checks if the element's options contain only the list of values (as values of the value attribute); order is not considered
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldHaveSuggestedItemsByInnerText	values	string[]	Checks if the element's options contain the list of values (as inner text); order is not considered
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldNotHaveSuggestedItemsByInnerText	values	string[]	Checks if the element's options do not contain the list of values (as inner text)
shouldHaveInnerTextPerOptionValue	optionValue	string	Checks if the element's option contain a particular combination of value of the value attribute and inner text
	innerText	string
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldNotHaveInnerTextPerOptionValue	optionValue	string	Checks if the element's option does not contain a particular combination of value of the value attribute and inner text
	innerText	string
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }
shouldHaveInnerTextsPerOptionValues	optionValues	string[]	Checks if the element's option list contain a particular combination of values of the value attribute and inner texts
	innerTexts	string[]
	options?	{ timeout?: number, assertionTimeout?: number, interval?: number, retries?: number, soft?: boolean }

Wait for functions

Simple wait for visibility functions

Name	Parameter(s)	Type	Description
waitUntilVisibility	options?	{ timeout?: number, interval?: number, retries?: number }	Waits for the element to be visible
waitUntilInvisibility	options?	{ timeout?: number, interval?: number, retries?: number }	Waits for the element to be invisible
waitUntilElementExists	options?	{ timeout?: number, interval?: number, retries?: number }	Waits for the element to exist
waitUntilElementNotExist	options?	{ timeout?: number, interval?: number, retries?: number }	Waits for the element not to exist

Complex wait for visibility functions

Allow filtering of available elements by index, text, attribute:

Name	Parameter(s)	Type	Description
waitUntilVisibilityByText	text	string	Filters collection of elements by text and waits for the element to be visible
	options?	{ timeout?: number, interval?: number, retries?: number }
waitUntilVisibilityByAttribute	attributeName	string	Filters collection of elements by attribute and waits for the element to be visible
	attributeValue	string
	options?	{ timeout?: number, interval?: number, retries?: number }
waitUntilVisibilityByIndex	index	number	Filters collection of elements by index and waits for the element to be visible
	options?	{ timeout?: number, interval?: number, retries?: number }
waitUntilInvisibilityByIndex	index	number	Filters collection of elements by index and waits for the element not to be visible
	options?	{ timeout?: number, interval?: number, retries?: number }

Wait for a collection size functions

Name	Parameter(s)	Type	Description
waitUntilCollectionOfElementsSizeIsGreaterOrEqual	expectedSize	number	Waits until collection of elements have specific size (or there are more)
	options?	{ timeout?: number, interval?: number, retries?: number }
waitUntilCollectionOfElementsSizeIsLessThan	expectedSize	number	Waits until collection of elements have fewer elements than specified
	options?	{ timeout?: number, interval?: number, retries?: number }

Actionability check

ActionabilityCheckTypes == attached | stable | visible | enabled | editable

Name	Parameter(s)	Type	Description
waitForSelectActionabilityCheck	check types	[]	Waits for the element to pass all the selected actionability check types
	isFilterByVisibility	boolean (true by default)

e.g.

await pega.dropdown('branch').waitForSelectActionabilityCheck(['attached', 'visible', 'stable']);

Other helpers

Name	Parameter(s)	Type	Description
focus	options?	{ timeout?: number, interval?: number, retries?: number }	Focuses the element. A focused element is ready to be activated with a keyboard or any keyboard-emulating technology
hover	options?	{ timeout?: number, interval?: number, retries?: number }	Hovers over the element. A hovered element is ready to be activated with a mouse or any mouse-emulating technology
pressTab			Simulates "press Tab key" action
click	options?	{ timeout?: number, interval?: number, retries?: number }	Clicks in the field

Boolean functions

Name	Parameter(s)	Type	Description
isVisible	options?	{ timeout?: number, interval?: number, retries?: number }	Returns true if the element exists and is visible
isExists	options?	{ timeout?: number, interval?: number, retries?: number }	Returns true if the element exists
isSelected	options?	{ timeout?: number, interval?: number, retries?: number }	Returns true if a dropdown option has a selected attribute

GetValue and GetText functions

Name	Parameter(s)	Type	Description
getValue			Returns element's value as a string
getText			Returns element's inner text as a string
getValues	options?	{ index?: number, timeout?: number, assertionTimeout?: number, interval?: number, retries?: number }	Returns element's values as a string[]

tip

Check a Key-Value Pair section for a better user experience with Dropdown fields.