Class: DataGridProDriver

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:48

Driver for Material UI v8 DataGridPro component. V8 DataGridPro component does not support data-testid, to use data-testid to locate the component, you need to put the data-testid on the parent element of the grid

See

https://mui.com/x/react-data-grid/

Extends

ComponentDriver<typeof parts>

Constructors

Constructor

new DataGridProDriver(locator, interactor, option?): DataGridProDriver

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:49

Parameters

locator

PartLocator

interactor

Interactor

option?

Partial<IComponentDriverOption<{ }>>

Returns

DataGridProDriver

Overrides

ComponentDriver<typeof parts>.constructor

Accessors

driverName

Get Signature

get driverName(): string

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:222

Returns

string

Overrides

ComponentDriver.driverName

Methods

getCell()

getCell<DriverT>(query, driverClass?): Promise<DriverT | null>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:140

Get the cell driver for the cell, if the cell does not exist, return null The cell driver is default to HTMLElementDriver, you can specify a different driver class

Type Parameters

DriverT

DriverT extends ComponentDriver<{ }>

Parameters

query

DataGridCellQuery

The query to locate the cell

driverClass?

ComponentDriverCtor<DriverT> = ...

Optional, the driver class to use for the cell, default to HTMLElementDriver

Returns

Promise<DriverT | null>

getCellText()

getCellText(query): Promise<string>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:162

Get the text content of the cell, if the cell does not exist, throw an error

Parameters

query

DataGridCellQuery

The query to locate the cell

Returns

Promise<string>

getColumnCount()

getColumnCount(): Promise<number>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:79

The number of columns currently displayed in the data grid, note that data grid pro uses virtualize rendering, therefore the column count heavily depends on the viewport size

Returns

Promise<number>

The number of columns currently displayed in the data grid

getHeaderText()

getHeaderText(): Promise<string[]>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:87

The array text of the header row, note that columns not shown in the viewport may not be included because of virtualize rendering

Returns

Promise<string[]>

The array of text of the header row

getPaginationDescription()

getPaginationDescription(): Promise<Optional<string>>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:216

Read the textual description of the current pagination state.

Returns

Promise<Optional<string>>

getRow()

getRow(rowIndex): Promise<DataGridHeaderRowDriver | null>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:110

Return the row driver for the row at the specified index, if the row does not exist, return null

Parameters

rowIndex

number

Returns

Promise<DataGridHeaderRowDriver | null>

getRowCount()

getRowCount(): Promise<number>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:96

The number of rows currently displayed in the data grid, note that data grid pro uses virtualize rendering, therefore the row count heavily depends on the viewport size

Returns

Promise<number>

The number of columns currently displayed in the data grid

getRowText()

getRowText(rowIndex): Promise<string[]>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:125

The array text of the specified row, note that columns not shown in the viewport may not be included because of virtualize rendering

Parameters

rowIndex

number

The index of the row

Returns

Promise<string[]>

The array of text of the specified row

gotoNextPage()

gotoNextPage(): Promise<void>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:208

Navigate to the next page using the grid footer control.

Returns

Promise<void>

gotoPreviousPage()

gotoPreviousPage(): Promise<void>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:192

Navigate to the previous page using the grid footer control.

Returns

Promise<void>

isFooterVisible()

isFooterVisible(): Promise<boolean>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:177

Determine if the pagination footer is currently visible.

Returns

Promise<boolean>

isLoading()

isLoading(): Promise<boolean>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:60

Checks if the data grid is currently loading.

Returns

Promise<boolean>

A promise that resolves to a boolean indicating if the data grid is loading.

isNextPageEnabled()

isNextPageEnabled(): Promise<boolean>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:200

Check whether the "next page" control is enabled.

Returns

Promise<boolean>

isPreviousPageEnabled()

isPreviousPageEnabled(): Promise<boolean>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:184

Check whether the "previous page" control is enabled.

Returns

Promise<boolean>

waitForLoad()

waitForLoad(timeoutMs?): Promise<void>

Defined in: component-driver-mui-x-v8/src/components/datagrid/DataGridProDriver.ts:69

Waits for the data grid to exit the loading state.

Parameters

timeoutMs?

number = 10000

The maximum time to wait for the load to complete, in milliseconds.

Returns

Promise<void>

Inherited members (20)

Properties

commutableOption

readonly commutableOption: CommutableComponentDriverOption

Defined in: core/dist/index.d.mts:1182

The component-agnostic slice of the constructor option that is safe to share across the whole driver tree — everything the constructor received EXCEPT the component-specific parts, which each driver owns for itself. Parent drivers pass this straight to the constructors of children they create dynamically (see the list helpers). See CommutableComponentDriverOption.

Inherited from

ComponentDriver.commutableOption

interactor

readonly interactor: Interactor

Defined in: core/dist/index.d.mts:1172

Inherited from

ComponentDriver.interactor

Accessors

locator

Get Signature

get locator(): PartLocator

Defined in: core/dist/index.d.mts:1229

Return the locator of the component

Returns

PartLocator

Inherited from

ComponentDriver.locator

parts

Get Signature

get parts(): ScenePartDriver<T>

Defined in: core/dist/index.d.mts:1225

Return driver instance of all the named parts

Returns

ScenePartDriver<T>

Inherited from

ComponentDriver.parts

Methods

click()

click(option?): Promise<void>

Defined in: core/dist/index.d.mts:1253

Parameters

option?

Partial<ClickOption>

Returns

Promise<void>

Inherited from

ComponentDriver.click

exists()

exists(): Promise<boolean>

Defined in: core/dist/index.d.mts:1252

Whether the component exists/attached to the DOM

Returns

Promise<boolean>

true if the component is attached to the DOM, false otherwise

Inherited from

ComponentDriver.exists

focus()

focus(option?): Promise<void>

Defined in: core/dist/index.d.mts:1262

Parameters

option?

Partial<FocusOption>

Returns

Promise<void>

Inherited from

ComponentDriver.focus

getAttribute()

getAttribute(attributeName): Promise<Optional<string>>

Defined in: core/dist/index.d.mts:1247

Parameters

attributeName

string

Returns

Promise<Optional<string>>

Inherited from

ComponentDriver.getAttribute

getText()

getText(): Promise<Optional<string>>

Defined in: core/dist/index.d.mts:1246

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

ComponentDriver.getText

hover()

hover(option?): Promise<void>

Defined in: core/dist/index.d.mts:1254

Parameters

option?

Partial<HoverOption>

Returns

Promise<void>

Inherited from

ComponentDriver.hover

isVisible()

isVisible(): Promise<boolean>

Defined in: core/dist/index.d.mts:1336

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 whether the component is within the viewport.

Returns

Promise<boolean>

true if the component is visible, false otherwise

Inherited from

ComponentDriver.isVisible

pressKey()

pressKey(key, option?): Promise<void>

Defined in: core/dist/index.d.mts:1268

Dispatch a keyboard key press on the component. See Interactor.pressKey.

Parameters

key

string

A KeyboardEvent.key value, e.g. 'Escape', 'Backspace', 'Enter'

option?

Partial<PressKeyOption>

Reserved for future modifier-key support

Returns

Promise<void>

Inherited from

ComponentDriver.pressKey

runtimeCssSelector()

runtimeCssSelector(): Promise<string>

Defined in: core/dist/index.d.mts:1367

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

ComponentDriver.runtimeCssSelector

scrollIntoView()

scrollIntoView(): Promise<void>

Defined in: core/dist/index.d.mts:1289

Scroll the component into the viewport. See Interactor.scrollIntoView.

jsdom has no layout engine, so the scroll is a no-op there and behavioral assertions (visibility, offset) are E2E-only.

Returns

Promise<void>

Inherited from

ComponentDriver.scrollIntoView

typeText()

typeText(text): Promise<void>

Defined in: core/dist/index.d.mts:1274

Type text into the component as real per-character keystrokes, inserting at the current caret without clearing. See Interactor.typeText.

Parameters

text

string

The literal text to type, one keystroke per character

Returns

Promise<void>

Inherited from

ComponentDriver.typeText

waitUntil()

waitUntil<T>(option): Promise<T>

Defined in: core/dist/index.d.mts:1356

Type Parameters

T

T

Parameters

option

WaitUntilOption<T>

Returns

Promise<T>

Inherited from

ComponentDriver.waitUntil

waitUntilComponentState()

waitUntilComponentState(option?): Promise<void>

Defined in: core/dist/index.d.mts:1355

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

ComponentDriver.waitUntilComponentState

waitUntilVisible()

waitUntilVisible(timeoutMs?): Promise<void>

Defined in: core/dist/index.d.mts:1343

Wait until the component is attached and becomes visible to the DOM.

Parameters

timeoutMs?

number

The number of milliseconds to wait before timing out. Defaults to defaultWaitForOption.timeoutMs so this wait shares a single flake-tolerance source with waitUntilComponentState (#1057).

Returns

Promise<void>

Inherited from

ComponentDriver.waitUntilVisible

overriddenParentLocator()

static overriddenParentLocator(): Optional<PartLocator>

Defined in: core/dist/index.d.mts:1211

Portal hook: where to re-root this driver's locator when its component renders outside the parent's DOM (a modal, popup, drawer). Return the PartLocator that locates the component from the document root, or undefined (the default) for normal in-tree components whose locator chains from the parent.

This is static because it is per-class metadata read off the constructor before any instance exists — which makes the "no instance state" constraint structural rather than a documented caution. Override with static override.

Returns

Optional<PartLocator>

Inherited from

ComponentDriver.overriddenParentLocator

overrideLocatorRelativePosition()

static overrideLocatorRelativePosition(): Optional<LocatorRelativePosition>

Defined in: core/dist/index.d.mts:1221

Portal hook: the locator relative position to apply when the component's real DOM is a sibling/elsewhere rather than a descendant (e.g. a MUI dialog rendered at the document root, located by a "Same"-level selector). Return undefined (the default) to keep the natural position declared by the ScenePart.

Static for the same reason as ComponentDriver.overriddenParentLocator: it is class-level metadata read before construction. Override with static override.

Returns

Optional<LocatorRelativePosition>

Inherited from

ComponentDriver.overrideLocatorRelativePosition

Protected members (16)

Methods

activate()

protected activate(): Promise<void>

Defined in: core/dist/index.d.mts:1282

Activate the component without relying on pointer geometry. See Interactor.activate.

Returns

Promise<void>

Inherited from

ComponentDriver.activate

contextMenu()

protected contextMenu(): Promise<void>

Defined in: core/dist/index.d.mts:1278

Dispatch a right-click / contextmenu event on the component. See Interactor.contextMenu.

Returns

Promise<void>

Inherited from

ComponentDriver.contextMenu

drag()

protected drag(delta): Promise<void>

Defined in: core/dist/index.d.mts:1320

Drag this component by the given pixel delta from its center. See Interactor.drag.

Prefer a keyboard-driven setValue over a true drag in real drivers — these drag primitives exist only for cases keyboard cannot express (e.g. panning a Lightbox, reordering a column). jsdom has no layout engine, so the positional outcome of the drag is E2E-only there.

Parameters

delta

Point

Pixel offset to drag by

Returns

Promise<void>

Inherited from

ComponentDriver.drag

dragTo()

protected dragTo(target): Promise<void>

Defined in: core/dist/index.d.mts:1309

Drag this component and drop it onto another component. See Interactor.dragTo.

Parameters

target

ComponentDriver<any>

Another driver whose root element is the drop target

Returns

Promise<void>

Inherited from

ComponentDriver.dragTo

enforcePartExistence()

protected enforcePartExistence(partName): Promise<void>

Defined in: core/dist/index.d.mts:1235

Check the specified parts' existences, and throw MissingPartError 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

Single or array of the names of the parts to be enforced

Returns

Promise<void>

Inherited from

ComponentDriver.enforcePartExistence

getBoundingRect()

protected getBoundingRect(): Promise<BoundingRect>

Defined in: core/dist/index.d.mts:1327

Get this component's bounding rectangle. See Interactor.getBoundingRect.

jsdom has no layout engine, so every coordinate and dimension is 0 there; real geometry is E2E-only.

Returns

Promise<BoundingRect>

Inherited from

ComponentDriver.getBoundingRect

getMissingPartNames()

protected getMissingPartNames(partName): Promise<readonly ("headerRow" | "loading" | "skeletonOverlay" | "footer")[]>

Defined in: core/dist/index.d.mts:1241

Get the names of parts not in the DOM

Parameters

partName

Single or array of the names of the parts to be examined

Returns

Promise<readonly ("headerRow" | "loading" | "skeletonOverlay" | "footer")[]>

Inherited from

ComponentDriver.getMissingPartNames

innerHTML()

protected innerHTML(): Promise<string>

Defined in: core/dist/index.d.mts:1361

Get the inner HTML of the component

Returns

Promise<string>

The inner HTML of the component

Inherited from

ComponentDriver.innerHTML

mouseDown()

protected mouseDown(option?): Promise<void>

Defined in: core/dist/index.d.mts:1256

Parameters

option?

Partial<MouseDownOption>

Returns

Promise<void>

Inherited from

ComponentDriver.mouseDown

mouseEnter()

protected mouseEnter(option?): Promise<void>

Defined in: core/dist/index.d.mts:1260

Parameters

option?

Partial<MouseEnterOption>

Returns

Promise<void>

Inherited from

ComponentDriver.mouseEnter

mouseLeave()

protected mouseLeave(option?): Promise<void>

Defined in: core/dist/index.d.mts:1261

Parameters

option?

Partial<MouseLeaveOption>

Returns

Promise<void>

Inherited from

ComponentDriver.mouseLeave

mouseMove()

protected mouseMove(option?): Promise<void>

Defined in: core/dist/index.d.mts:1255

Parameters

option?

Partial<MouseMoveOption>

Returns

Promise<void>

Inherited from

ComponentDriver.mouseMove

mouseOut()

protected mouseOut(option?): Promise<void>

Defined in: core/dist/index.d.mts:1259

Parameters

option?

Partial<MouseOutOption>

Returns

Promise<void>

Inherited from

ComponentDriver.mouseOut

mouseOver()

protected mouseOver(option?): Promise<void>

Defined in: core/dist/index.d.mts:1258

Parameters

option?

Partial<HoverOption>

Returns

Promise<void>

Inherited from

ComponentDriver.mouseOver

mouseUp()

protected mouseUp(option?): Promise<void>

Defined in: core/dist/index.d.mts:1257

Parameters

option?

Partial<MouseUpOption>

Returns

Promise<void>

Inherited from

ComponentDriver.mouseUp

scrollBy()

protected scrollBy(delta): Promise<void>

Defined in: core/dist/index.d.mts:1298

Scroll the component by the given pixel delta. See Interactor.scrollBy.

jsdom has no layout engine, so the scroll is a no-op there and behavioral assertions (resulting offset) are E2E-only.

Parameters

delta

Point

Pixel offset to scroll by

Returns

Promise<void>

Inherited from

ComponentDriver.scrollBy

See​

Extends​

Constructors​

Constructor​

Parameters​

locator​

interactor​

option?​

Returns​

Overrides​

Accessors​

driverName​

Get Signature​

Returns​

Overrides​

Methods​

getCell()​

Type Parameters​

DriverT​

Parameters​

query​

driverClass?​

Returns​

getCellText()​

Parameters​

query​

Returns​

getColumnCount()​

Returns​

getHeaderText()​

Returns​

getPaginationDescription()​

Returns​

getRow()​

Parameters​

rowIndex​

Returns​

getRowCount()​

Returns​

getRowText()​

Parameters​

rowIndex​

Returns​

gotoNextPage()​

Returns​

gotoPreviousPage()​

Returns​

isFooterVisible()​

Returns​

isLoading()​

Returns​

isNextPageEnabled()​

Returns​

isPreviousPageEnabled()​

Returns​

waitForLoad()​

Parameters​

timeoutMs?​

Returns​

Properties​

commutableOption​

Inherited from​

interactor​

Inherited from​

Accessors​

locator​

Get Signature​

Returns​

Inherited from​

parts​

Get Signature​

Returns​

Inherited from​

Methods​

click()​

Parameters​

option?​

Returns​

Inherited from​

exists()​

See

Extends

Constructors

Constructor

Parameters

locator

interactor

option?

Returns

Overrides

Accessors

driverName

Get Signature

Returns

Overrides

Methods

getCell()

Type Parameters

DriverT

Parameters

query

driverClass?

Returns

getCellText()

Parameters

query

Returns

getColumnCount()

Returns

getHeaderText()

Returns

getPaginationDescription()

Returns

getRow()

Parameters

rowIndex

Returns

getRowCount()

Returns

getRowText()

Parameters

rowIndex

Returns

gotoNextPage()

Returns

gotoPreviousPage()

Returns

isFooterVisible()

Returns

isLoading()

Returns

isNextPageEnabled()

Returns

isPreviousPageEnabled()

Returns

waitForLoad()

Parameters

timeoutMs?

Returns

Properties

commutableOption

Inherited from

interactor

Inherited from

Accessors

locator

Get Signature

Returns

Inherited from

parts

Get Signature

Returns

Inherited from

Methods

click()

Parameters

option?

Returns

Inherited from

exists()