Interface: Interactor
Defined in: packages/core/src/interactor/Interactor.ts:27
Environment specific implementation that performs low level actions on the UI.
Component drivers delegate every interaction to an instance of this interface so tests can run in different environments by simply providing a different interactor implementation.
Methods​
blur()​
blur(
locator,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:62
Remove focus from the desired element
Parameters​
locator​
option?​
Partial<BlurOption>
Returns​
Promise<void>
click()​
click(
locator,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:34
Click on the desired element
Parameters​
locator​
option?​
Partial<ClickOption>
Returns​
Promise<void>
clone()​
clone():
Interactor
Defined in: packages/core/src/interactor/Interactor.ts:153
Returns​
Interactor
enterText()​
enterText(
locator,text,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:69
Type text into the desired element
Parameters​
locator​
text​
string
option?​
Partial<EnterTextOption>
Returns​
Promise<void>
exists()​
exists(
locator):Promise<boolean>
Defined in: packages/core/src/interactor/Interactor.ts:136
Parameters​
locator​
Returns​
Promise<boolean>
focus()​
focus(
locator,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:55
Parameters​
locator​
option?​
Partial<FocusOption>
Returns​
Promise<void>
getAttribute()​
Call Signature​
getAttribute(
locator,name,isMultiple):Promise<readonlystring[]>
Defined in: packages/core/src/interactor/Interactor.ts:124
Parameters​
locator​
name​
string
isMultiple​
true
Returns​
Promise<readonly string[]>
Call Signature​
getAttribute(
locator,name,isMultiple):Promise<Optional<string>>
Defined in: packages/core/src/interactor/Interactor.ts:125
Parameters​
locator​
name​
string
isMultiple​
false
Returns​
Promise<Optional<string>>
Call Signature​
getAttribute(
locator,name):Promise<Optional<string>>
Defined in: packages/core/src/interactor/Interactor.ts:126
Parameters​
locator​
name​
string
Returns​
Promise<Optional<string>>
getInputValue()​
getInputValue(
locator):Promise<Optional<string>>
Defined in: packages/core/src/interactor/Interactor.ts:112
Parameters​
locator​
Returns​
Promise<Optional<string>>
getSelectLabels()​
getSelectLabels(
locator):Promise<Optional<readonlystring[]>>
Defined in: packages/core/src/interactor/Interactor.ts:122
Get the select element's selected options' labels
Parameters​
locator​
Returns​
Promise<Optional<readonly string[]>>
getSelectValues()​
getSelectValues(
locator):Promise<Optional<readonlystring[]>>
Defined in: packages/core/src/interactor/Interactor.ts:117
Get the select element's selected options' values
Parameters​
locator​
Returns​
Promise<Optional<readonly string[]>>
getStyleValue()​
getStyleValue(
locator,propertyName):Promise<Optional<string>>
Defined in: packages/core/src/interactor/Interactor.ts:133
Get the value of a style property
Parameters​
locator​
propertyName​
Returns​
Promise<Optional<string>>
getText()​
getText(
locator):Promise<Optional<string>>
Defined in: packages/core/src/interactor/Interactor.ts:135
Parameters​
locator​
Returns​
Promise<Optional<string>>
hasAttribute()​
hasAttribute(
locator,name):Promise<boolean>
Defined in: packages/core/src/interactor/Interactor.ts:143
Parameters​
locator​
name​
string
Returns​
Promise<boolean>
hasCssClass()​
hasCssClass(
locator,className):Promise<boolean>
Defined in: packages/core/src/interactor/Interactor.ts:142
Parameters​
locator​
className​
string
Returns​
Promise<boolean>
hover()​
hover(
locator,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:82
Perform a mouse hover on the desired element
Parameters​
locator​
option?​
Returns​
Promise<void>
innerHTML()​
innerHTML(
locator):Promise<string>
Defined in: packages/core/src/interactor/Interactor.ts:151
Get the HTML of an element
Parameters​
locator​
Returns​
Promise<string>
isChecked()​
isChecked(
locator):Promise<boolean>
Defined in: packages/core/src/interactor/Interactor.ts:137
Parameters​
locator​
Returns​
Promise<boolean>
isDisabled()​
isDisabled(
locator):Promise<boolean>
Defined in: packages/core/src/interactor/Interactor.ts:138
Parameters​
locator​
Returns​
Promise<boolean>
isReadonly()​
isReadonly(
locator):Promise<boolean>
Defined in: packages/core/src/interactor/Interactor.ts:139
Parameters​
locator​
Returns​
Promise<boolean>
isVisible()​
isVisible(
locator):Promise<boolean>
Defined in: packages/core/src/interactor/Interactor.ts:140
Parameters​
locator​
Returns​
Promise<boolean>
mouseDown()​
mouseDown(
locator,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:43
Parameters​
locator​
option?​
Partial<MouseDownOption>
Returns​
Promise<void>
mouseEnter()​
mouseEnter(
locator,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:51
Parameters​
locator​
option?​
Partial<MouseEnterOption>
Returns​
Promise<void>
mouseLeave()​
mouseLeave(
locator,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:53
Parameters​
locator​
option?​
Partial<MouseLeaveOption>
Returns​
Promise<void>
mouseMove()​
mouseMove(
locator,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:41
Mouse move on the desired element
Parameters​
locator​
option?​
Partial<MouseMoveOption>
Returns​
Promise<void>
mouseOut()​
mouseOut(
locator,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:49
Parameters​
locator​
option?​
Partial<MouseOutOption>
Returns​
Promise<void>
mouseOver()​
mouseOver(
locator,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:47
Parameters​
locator​
option?​
Partial<HoverOption>
Returns​
Promise<void>
mouseUp()​
mouseUp(
locator,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:45
Parameters​
locator​
option?​
Partial<MouseUpOption>
Returns​
Promise<void>
selectOptionValue()​
selectOptionValue(
locator,values):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:76
Select option by value from a select element
Parameters​
locator​
values​
string[]
Returns​
Promise<void>
wait()​
wait(
ms):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:88
Wait for a given amount of time in milliseconds
Parameters​
ms​
number
Returns​
Promise<void>
waitUntil()​
waitUntil<
T>(option):Promise<T>
Defined in: packages/core/src/interactor/Interactor.ts:108
Keep running a probe function until it returns a value that matches the terminate condition or timeout
Type Parameters​
T​
T
Parameters​
option​
Returns​
Promise<T>
The last value returned by the probe function
waitUntilComponentState()​
waitUntilComponentState(
locator,option?):Promise<void>
Defined in: packages/core/src/interactor/Interactor.ts:102
Wait until the component is in the expected state such as the component's visibility or existence. If the component has not reached the expected state within the timeout, it will throw an error.
By default it waits until the component is attached to the DOM within 30 seconds.
Parameters​
locator​
The locator of the component to wait for
option?​
Partial<Readonly<WaitForOption>>
The option to configure the wait behavior
Returns​
Promise<void>