Button Functions

This section documents button interaction functions used in the automation testing suite.

cancelButton

cancelButton(page)

Arguments:

• page (Page)

Returns:

Promise –

clickButtonWithChecks

clickButtonWithChecks(page, buttonName, screenshotLabel)

Arguments:

• page (Page)

• buttonName (string)

• screenshotLabel (string)

Returns:

Promise –

clickButtonWithWait

clickButtonWithWait(page, buttonName, waitTime)

Arguments:

• page (Page)

• buttonName (string)

• waitTime (number)

Returns:

Promise –

clickDropdownFromSideBar

clickDropdownFromSideBar(page, tabToExpand, optionToSelect, secondOptionToSelect, expandTimeout, optionTimeout, retryAttempts, retryDelayMs)

Arguments:

• page (Page)

• tabToExpand (string)

• optionToSelect (string)

• secondOptionToSelect (string)

• expandTimeout (number)

• optionTimeout (number)

• retryAttempts (number)

• retryDelayMs (number)

Returns:

Promise –

clickFieldWithWait

Deprecated since version 1.0: Use clickButtonWithWait or Playwright’s built-in locator actions instead.

clickFieldWithWait(page, fieldText, waitTime, useLocator, multipleMatchStrategy)

Arguments:

• page (Page)

• fieldText (string)

• waitTime (number)

• useLocator (string)

Returns:

Promise –

clickFinishButton

clickFinishButton(page)

Arguments:

• page (Page)

Returns:

Promise –

clickInvoiceRowButton

Deprecated since version 1.0: Use selectActionFromRow instead.

clickInvoiceRowButton(page, rowText, buttonIndex)

Arguments:

• page (Page)

• rowText (string)

• buttonIndex (number)

Returns:

Promise –

clickNextButton

buttons.clickNextButton(page)

Arguments:

• page (Page)

Returns:

Promise –

firstChoiceSafeClick

Deprecated since version 1.0: Use safeClick or safeClickOption instead.

firstChoiceSafeClick(page, identifier, timeout, force)

Arguments:

• page (Page)

• identifier (string)

• timeout (number)

• force (boolean)

Returns:

Promise –

okButton

okButton(page)

Arguments:

• page (Page)

Returns:

Promise –

randomChoiceSafeClick

Deprecated since version 1.0: Use safeClick or safeClickOption instead.

randomChoiceSafeClick(page, identifier, timeout, force)

Arguments:

• page (Page)

• identifier (string)

• timeout (number)

• force (boolean)

Returns:

Promise –

safeClick

safeClick(page, identifier, options)

Arguments:

• page (Page)

Returns:

Promise –

safeClickOption

safeClickOption(page, identifier, options)

Arguments:

• page (Page)

Returns:

Promise –

safeClickSkipIfMultiple

safeClickSkipIfMultiple(page, identifier, options)

Arguments:

• page (Page)

Returns:

Promise –

safeClickWithDelay

safeClickWithDelay(page, identifier, options, delayMs)

Arguments:

• page (Page)

• delayMs (number)

Returns:

Promise –

safeFill

safeFill(page, identifier, value, tabFallbackCount, useExactMatch, stepTimeout)

Arguments:

• page (Page)

• identifier (string)

• value (string)

• tabFallbackCount (number)

• useExactMatch (boolean)

• stepTimeout (number)

Returns:

Promise –

safeSelect

safeSelect(page, identifier, optionName)

Arguments:

• page (Page)

• identifier (string)

• optionName (string)

Returns:

Promise –

saveButton

saveButton(page)

Arguments:

• page (Page)

Returns:

Promise –

selectActionFromRow

selectActionFromRow(page, rowIdentifier, buttonIndex, expectedText)

Arguments:

• page (Page)

• buttonIndex (number)

Returns:

Promise –

selectDropdownOption

Deprecated since version 1.0: Use testDropdownOptions or direct dropdown interactions instead.

selectDropdownOption(page, dropdownLabel, preferredOption)

Selects an option from a dropdown, with fallback to first available option.

Arguments:

• page (Page)

• dropdownLabel (string)

• preferredOption (string)

Returns:

Promise –