Class: ExclusiveToggleButtonGroupDriver
Defined in: packages/component-driver-mui-v5/src/components/ToggleButtonGroupDriver.ts:46
Extends
Implements
IInputDriver<string|null>
Constructors
Constructor
new ExclusiveToggleButtonGroupDriver(
locator,interactor,option?):ExclusiveToggleButtonGroupDriver
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:21
Parameters
locator
PartLocator
interactor
Interactor
option?
Partial<IComponentDriverOption<{ }>>
Returns
ExclusiveToggleButtonGroupDriver
Inherited from
ToggleButtonGroupDriver.constructor
Properties
commutableOption
readonlycommutableOption:IComponentDriverOption<{ }>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:20
Option passed to the constructor includes both universal options which can be shared across all component driver tree, and component specific options which are only applicable to the component.
Commutable option is the option that can be shared across all component driver tree.
Inherited from
ToggleButtonGroupDriver.commutableOption
interactor
readonlyinteractor:Interactor
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:11
Inherited from
ToggleButtonGroupDriver.interactor
itemLocator
protecteditemLocator:PartLocator
Defined in: packages/component-driver-mui-v5/src/components/ToggleButtonGroupDriver.ts:8
Inherited from
ToggleButtonGroupDriver.itemLocator
Accessors
driverName
Get Signature
get driverName():
string
Defined in: packages/component-driver-mui-v5/src/components/ToggleButtonGroupDriver.ts:62
Returns
string
Overrides
ToggleButtonGroupDriver.driverName
locator
Get Signature
get locator():
PartLocator
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:51
Return the locator of the component
Returns
PartLocator
Inherited from
ToggleButtonGroupDriver.locator
parts
Get Signature
get parts():
ScenePartDriver<T>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:47
Return driver instance of all the named parts
Returns
ScenePartDriver<T>
Inherited from
Methods
click()
click(
option?):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:75
Parameters
option?
Partial<ClickOption>
Returns
Promise<void>
Inherited from
enforcePartExistence()
protectedenforcePartExistence(partName):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:57
Check the specified parts' existences, and throw MissPartError if any of the part is found not existence. Existence is defined by the part's existence in the DOM regardless of its visibility on the screen
Parameters
partName
readonly never[]
Single or array of the names of the parts to be enforced
Returns
Promise<void>
Inherited from
ToggleButtonGroupDriver.enforcePartExistence
exists()
exists():
Promise<boolean>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:74
Whether the component exists/attached to the DOM
Returns
Promise<boolean>
true if the component is attached to the DOM, false otherwise
Inherited from
ToggleButtonGroupDriver.exists
focus()
focus(
option?):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:84
Parameters
option?
Partial<FocusOption>
Returns
Promise<void>
Inherited from
getAttribute()
getAttribute(
attributeName):Promise<Optional<string>>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:69
Parameters
attributeName
string
Returns
Promise<Optional<string>>
Inherited from
ToggleButtonGroupDriver.getAttribute
getMissingPartNames()
protectedgetMissingPartNames(partName):Promise<readonlynever[]>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:63
Get the names of parts not in the DOM
Parameters
partName
readonly never[]
Single or array of the names of the parts to be examined
Returns
Promise<readonly never[]>
Inherited from
ToggleButtonGroupDriver.getMissingPartNames
getText()
getText():
Promise<Optional<string>>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:68
Get the combined text content of the component
Returns
Promise<Optional<string>>
If the component exists and has content, it should return the text or otherwise undefined
Inherited from
ToggleButtonGroupDriver.getText
getValue()
getValue():
Promise<null|string>
Defined in: packages/component-driver-mui-v5/src/components/ToggleButtonGroupDriver.ts:48
Get all the selected toggle buttons' values.
Returns
Promise<null | string>
Implementation of
IInputDriver.getValue
Overrides
ToggleButtonGroupDriver.getValue
hover()
hover(
option?):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:76
Parameters
option?
Partial<HoverOption>
Returns
Promise<void>
Inherited from
innerHTML()
innerHTML():
Promise<string>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:116
Get the inner HTML of the component
Returns
Promise<string>
The inner HTML of the component
Inherited from
ToggleButtonGroupDriver.innerHTML
isVisible()
isVisible():
Promise<boolean>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:93
Whether the component is visible. Visibility is defined
that the component does not have the CSS property display: none,
visibility: hidden, or opacity: 0. However this does not
check wether the component is within the viewport.
Returns
Promise<boolean>
true if the component is visible, false otherwise
Inherited from
ToggleButtonGroupDriver.isVisible
mouseDown()
mouseDown(
option?):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:78
Parameters
option?
Partial<MouseDownOption>
Returns
Promise<void>
Inherited from
ToggleButtonGroupDriver.mouseDown
mouseEnter()
mouseEnter(
option?):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:82
Parameters
option?
Partial<MouseEnterOption>
Returns
Promise<void>
Inherited from
ToggleButtonGroupDriver.mouseEnter
mouseLeave()
mouseLeave(
option?):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:83
Parameters
option?
Partial<MouseLeaveOption>
Returns
Promise<void>
Inherited from
ToggleButtonGroupDriver.mouseLeave
mouseMove()
mouseMove(
option?):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:77
Parameters
option?
Partial<MouseMoveOption>
Returns
Promise<void>
Inherited from
ToggleButtonGroupDriver.mouseMove
mouseOut()
mouseOut(
option?):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:81
Parameters
option?
Partial<MouseOutOption>
Returns
Promise<void>
Inherited from
ToggleButtonGroupDriver.mouseOut
mouseOver()
mouseOver(
option?):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:80
Parameters
option?
Partial<HoverOption>
Returns
Promise<void>
Inherited from
ToggleButtonGroupDriver.mouseOver
mouseUp()
mouseUp(
option?):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:79
Parameters
option?
Partial<MouseUpOption>
Returns
Promise<void>
Inherited from
ToggleButtonGroupDriver.mouseUp
overriddenParentLocator()
overriddenParentLocator():
Optional<PartLocator>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:31
Usually this should be undefined as the component driver corresponds to a component nested inside the parent DOM, thus the driver's locator would automatically chain with its parent's locator.
When the component is rendered outside the parent's DOM, which usually happens when the component is a modal or popup, supply the PartLocator on how to locate the component with the component's own locator.
Caution of usage: this function is called before the construction of the driver, so it should not use any instance properties
Returns
Optional<PartLocator>
Inherited from
ToggleButtonGroupDriver.overriddenParentLocator
overrideLocatorRelativePosition()
overrideLocatorRelativePosition():
Optional<LocatorRelativePosition>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:43
Usually this should be undefined when the locator is defined by the ScenePart, thus it reflects the natural relative position of the component
However, in some implementation such as MUI v5 dialog, the actual dialog DOM is rendered outside the parent DOM, and the selector is "siblings", by defining this function, it allows the driver to have the knowledge of the actual relative position instead of offloading the knowledge to the consumer.
Caution of usage: this function is called before the construction of the driver, so it should not use any instance properties
Returns
Optional<LocatorRelativePosition>
Inherited from
ToggleButtonGroupDriver.overrideLocatorRelativePosition
runtimeCssSelector()
runtimeCssSelector():
Promise<string>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:122
Get the runtime CSS selector of the component. This is useful for debugging and testing purposes.
Returns
Promise<string>
The runtime CSS selector of the component
Inherited from
ToggleButtonGroupDriver.runtimeCssSelector
setValue()
setValue(
value):Promise<boolean>
Defined in: packages/component-driver-mui-v5/src/components/ToggleButtonGroupDriver.ts:54
Toggle all the toggle buttons such that only those with value in the given array are selected.
Parameters
value
Always true
null | string
Returns
Promise<boolean>
Implementation of
IInputDriver.setValue
Overrides
ToggleButtonGroupDriver.setValue
waitUntil()
waitUntil<
T>(option):Promise<T>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:111
Type Parameters
T
T
Parameters
option
WaitUntilOption<T>
Returns
Promise<T>
Inherited from
ToggleButtonGroupDriver.waitUntil
waitUntilComponentState()
waitUntilComponentState(
option?):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:110
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
option?
Partial<Readonly<WaitForOption>>
The option to configure the wait behavior
Returns
Promise<void>
Inherited from
ToggleButtonGroupDriver.waitUntilComponentState
waitUntilVisible()
waitUntilVisible(
timeoutMs?):Promise<void>
Defined in: packages/core/build/src/drivers/ComponentDriver.d.ts:98
Wait until the component is attached and becomes visible to the DOM.
Parameters
timeoutMs?
number
The number of milliseconds to wait before timing out
Returns
Promise<void>