Class: DataGridDataRowDriver
@atomic-testing/component-driver-mui-v5.DataGridDataRowDriver
Hierarchy
-
DataGridRowDriver
↳
DataGridDataRowDriver
Constructors
constructor
• new DataGridDataRowDriver(locator
, interactor
, option?
): DataGridDataRowDriver
Parameters
Name | Type |
---|---|
locator | PartLocator |
interactor | Interactor |
option? | Partial <IComponentDriverOption <>> |
Returns
Overrides
DataGridRowDriver.constructor
Defined in
packages/component-driver-mui-v5/src/components/datagrid/DataGridDataRowDriver.ts:7
Properties
_dataCellLocator
• Private
Readonly
_dataCellLocator: PartLocator
Defined in
packages/component-driver-mui-v5/src/components/datagrid/DataGridDataRowDriver.ts:6
commutableOption
• Readonly
commutableOption: IComponentDriverOption
<>
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
DataGridRowDriver.commutableOption
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:19
interactor
• Readonly
interactor: Interactor
Inherited from
DataGridRowDriver.interactor
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:10
Accessors
driverName
• get
driverName(): string
Returns
string
Overrides
DataGridRowDriver.driverName
Defined in
packages/component-driver-mui-v5/src/components/datagrid/DataGridDataRowDriver.ts:20
locator
• get
locator(): PartLocator
Return the locator of the component
Returns
PartLocator
Inherited from
DataGridRowDriver.locator
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:50
parts
• get
parts(): ScenePartDriver
<T
>
Return driver instance of all the named parts
Returns
ScenePartDriver
<T
>
Inherited from
DataGridRowDriver.parts
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:46
Methods
click
▸ click(option?
): Promise
<void
>
Parameters
Name | Type |
---|---|
option? | Partial <ClickOption > |
Returns
Promise
<void
>
Inherited from
DataGridRowDriver.click
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:74
enforcePartExistence
▸ enforcePartExistence(partName
): Promise
<void
>
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
Name | Type | Description |
---|---|---|
partName | readonly never [] | Single or array of the names of the parts to be enforced |
Returns
Promise
<void
>
Inherited from
DataGridRowDriver.enforcePartExistence
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:56
exists
▸ exists(): Promise
<boolean
>
Whether the component exists/attached to the DOM
Returns
Promise
<boolean
>
true if the component is attached to the DOM, false otherwise
Inherited from
DataGridRowDriver.exists
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:73
focus
▸ focus(option?
): Promise
<void
>
Parameters
Name | Type |
---|---|
option? | Partial <FocusOption > |
Returns
Promise
<void
>
Inherited from
DataGridRowDriver.focus
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:83
getAttribute
▸ getAttribute(attributeName
): Promise
<Optional
<string
>>
Parameters
Name | Type |
---|---|
attributeName | string |
Returns
Promise
<Optional
<string
>>
Inherited from
DataGridRowDriver.getAttribute
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:68
getCell
▸ getCell<DriverT
>(cellIndexOrField
, driverClass?
): Promise
<null
| DriverT
>
Get the cell driver at the specified index or data field. Caveat: Because of virtualization, the cell may not be available until the cell is visible.
Type parameters
Name | Type |
---|---|
DriverT | extends ComponentDriver <> |
Parameters
Name | Type | Default value | Description |
---|---|---|---|
cellIndexOrField | string | number | undefined | number: column index, string: column field |
driverClass | typeof ComponentDriver | HTMLElementDriver | The driver class of the cell. Default is HTMLElementDriver |
Returns
Promise
<null
| DriverT
>
A promise of the cell driver, or null if the cell is not found
Inherited from
DataGridRowDriver.getCell
Defined in
packages/component-driver-mui-v5/src/components/datagrid/DataGridRowDriver.ts:34
getCellCount
▸ getCellCount(): Promise
<number
>
Returns
Promise
<number
>
Inherited from
DataGridRowDriver.getCellCount
Defined in
packages/component-driver-mui-v5/src/components/datagrid/DataGridRowDriver.ts:5
getCellLocator
▸ getCellLocator(): PartLocator
Returns
PartLocator
Overrides
DataGridRowDriver.getCellLocator
Defined in
packages/component-driver-mui-v5/src/components/datagrid/DataGridDataRowDriver.ts:16
getMissingPartNames
▸ getMissingPartNames(partName
): Promise
<readonly never
[]>
Get the names of parts not in the DOM
Parameters
Name | Type | Description |
---|---|---|
partName | readonly never [] | Single or array of the names of the parts to be examined |
Returns
Promise
<readonly never
[]>
Inherited from
DataGridRowDriver.getMissingPartNames
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:62
getRowText
▸ getRowText(): Promise
<string
[]>
Get the text of each visible cell in the row. Caveat: Because of virtualization, the text of the cell may not be available until the cell is visible.
Returns
Promise
<string
[]>
A promise array of text of each visible cell in the row
Inherited from
DataGridRowDriver.getRowText
Defined in
packages/component-driver-mui-v5/src/components/datagrid/DataGridRowDriver.ts:18
getText
▸ getText(): Promise
<Optional
<string
>>
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
DataGridRowDriver.getText
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:67
hover
▸ hover(option?
): Promise
<void
>
Parameters
Name | Type |
---|---|
option? | Partial <HoverOption > |
Returns
Promise
<void
>
Inherited from
DataGridRowDriver.hover
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:75
isVisible
▸ isVisible(): Promise
<boolean
>
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
DataGridRowDriver.isVisible
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:92
mouseDown
▸ mouseDown(option?
): Promise
<void
>
Parameters
Name | Type |
---|---|
option? | Partial <MouseDownOption > |
Returns
Promise
<void
>
Inherited from
DataGridRowDriver.mouseDown
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:77
mouseEnter
▸ mouseEnter(option?
): Promise
<void
>
Parameters
Name | Type |
---|---|
option? | Partial <MouseEnterOption > |
Returns
Promise
<void
>
Inherited from
DataGridRowDriver.mouseEnter
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:81
mouseLeave
▸ mouseLeave(option?
): Promise
<void
>
Parameters
Name | Type |
---|---|
option? | Partial <MouseLeaveOption > |
Returns
Promise
<void
>
Inherited from
DataGridRowDriver.mouseLeave
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:82
mouseMove
▸ mouseMove(option?
): Promise
<void
>
Parameters
Name | Type |
---|---|
option? | Partial <MouseMoveOption > |
Returns
Promise
<void
>
Inherited from
DataGridRowDriver.mouseMove
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:76
mouseOut
▸ mouseOut(option?
): Promise
<void
>
Parameters
Name | Type |
---|---|
option? | Partial <MouseOutOption > |
Returns
Promise
<void
>
Inherited from
DataGridRowDriver.mouseOut
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:80
mouseOver
▸ mouseOver(option?
): Promise
<void
>
Parameters
Name | Type |
---|---|
option? | Partial <HoverOption > |
Returns
Promise
<void
>
Inherited from
DataGridRowDriver.mouseOver
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:79
mouseUp
▸ mouseUp(option?
): Promise
<void
>
Parameters
Name | Type |
---|---|
option? | Partial <MouseUpOption > |
Returns
Promise
<void
>
Inherited from
DataGridRowDriver.mouseUp
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:78
overriddenParentLocator
▸ overriddenParentLocator(): Optional
<PartLocator
>
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
DataGridRowDriver.overriddenParentLocator
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:30
overrideLocatorRelativePosition
▸ overrideLocatorRelativePosition(): Optional
<LocatorRelativePosition
>
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
DataGridRowDriver.overrideLocatorRelativePosition
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:42
waitUntil
▸ waitUntil(option?
): Promise
<void
>
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
Name | Type | Description |
---|---|---|
option? | Partial <Readonly <WaitForOption >> | The option to configure the wait behavior |
Returns
Promise
<void
>
Inherited from
DataGridRowDriver.waitUntil
Defined in
packages/core/build/src/drivers/ComponentDriver.d.ts:104