import { PlumaTestHelpers } from '@customerio/pluma-components/react/test-helpers/pluma-test-helpers'

const dataTable = PlumaTestHelpers.extract('DataTable', screen.getByRole('table'));

Test Helpers

`DataTableTestHelpers`

`clearSearch`() `=> Promise<void>`

Clears the search input

`clickButton`
(
`buttonName:string | RegExp`
)
`=> Promise<void>`

Clicks a button by name

`clickRow`
(
`rowIndex:number`
)
`=> Promise<void>`

Clicks on a row (for clickable rows)

`clickRowById`
(
`rowId:string`
)
`=> Promise<void>`

Clicks on a row identified by its row ID (for clickable rows)

`deselectAllRows`() `=> Promise<void>`

Deselects all rows by clicking the "deselect all" checkbox

`deselectRow`
(
`rowIndex:number`
)
`=> Promise<void>`

Deselects a specific row by clicking its checkbox

`deselectRowById`
(
`rowId:string`
)
`=> Promise<void>`

Deselects a row identified by its row ID by clicking its checkbox

`getCell`
(
`rowIndex:number,`
`columnId:string`
)
`=> HTMLElement | null`

Gets the HTML element of a specific cell

`getCellById`
(
`rowId:string,`
`columnId:string`
)
`=> HTMLElement | null`

Gets the HTML element of a specific cell in a row identified by its row ID

`getCellContent`
(
`rowIndex:number,`
`columnId:string`
)
`=> string`

Gets content of a specific cell

`getCellContentById`
(
`rowId:string,`
`columnId:string`
)
`=> string`

Gets content of a specific cell in a row identified by its row ID

`getColumnHeaders`() `=> string[]`

Gets array of visible column header texts

`getColumnOrder`() `=> string[]`

Gets current column order

`getErrorState`() `=> boolean`

Checks for error states

`getIsEmpty`() `=> boolean`

Checks if the table shows empty state

`getIsRowSelected`
(
`rowIndex:number`
)
`=> boolean`

Checks if a specific row is selected

`getIsRowSelectedById`
(
`rowId:string`
)
`=> boolean`

Checks if a row identified by its row ID is selected

`getLoadingIndicator`() `=> HTMLElement | null`

Finds loading indicator

`getRow`
(
`rowIndex:number`
)
`=> HTMLElement | null`

Gets a row element by its zero-based index

`getRowActions`
(
`rowIndex:number`
)
`=> string[]`

Gets available actions for a specific row

`getRowActionsById`
(
`rowId:string`
)
`=> string[]`

Gets available actions for a row identified by its row ID

`getRowById`
(
`rowId:string`
)
`=> HTMLElement | null`

Gets a row element by its row ID

`getRowClickHandler`
(
`rowIndex:number`
)
`=> boolean`

Checks if row is clickable

`getRowClickHandlerById`
(
`rowId:string`
)
`=> boolean`

Checks if a row identified by its row ID is clickable

`getRowCount`() `=> number`

Gets the total number of data rows in the table

`getRowData`
(
`rowIndex:number`
)
`=> string[]`

Gets content of all cells in a specific row

`getRowDataById`
(
`rowId:string`
)
`=> string[]`

Gets content of all cells in a row identified by its row ID

`getRowHref`
(
`rowIndex:number`
)
`=> string | null`

Gets href if row is a link

`getRowHrefById`
(
`rowId:string`
)
`=> string | null`

Gets href if a row identified by its row ID is a link

`getSearchQuery`() `=> string`

Gets the current search query

`getSelectedRowCount`() `=> number`

Gets the number of selected rows

`getVisibleColumns`() `=> string[]`

Gets list of currently visible columns

`getVisibleRowCount`() `=> number`

Gets the number of currently visible rows (accounting for pagination/filters)

`goToNextPage`() `=> Promise<void>`

Navigates to the next page

`goToPreviousPage`() `=> Promise<void>`

Navigates to the previous page

`hasButton`
(
`buttonName:string | RegExp`
)
`=> boolean`

Checks if a button exists and is enabled

`hasNextPage`() `=> boolean`

Checks if there are more pages available (next button enabled)

`hasPreviousPage`() `=> boolean`

Checks if there are previous pages available (previous button enabled)

`hasRowActions`
(
`rowIndex:number`
)
`=> boolean`

Checks if a row has action menu/buttons

`hasRowActionsById`
(
`rowId:string`
)
`=> boolean`

Checks if a row identified by its row ID has action menu/buttons

`hasSearchResults`() `=> boolean`

Checks if search returned results

`loadMore`() `=> Promise<void>`

Triggers load more functionality

`loadNew`() `=> Promise<void>`

Triggers load new data

`navigateToCell`
(
`rowIndex:number,`
`columnIndex:number`
)
`=> Promise<void>`

Focuses specific cell

`navigateToCellById`
(
`rowId:string,`
`columnIndex:number`
)
`=> Promise<void>`

Focuses a specific cell in a row identified by its row ID

`navigateToRow`
(
`rowIndex:number`
)
`=> Promise<void>`

Focuses specific row

`navigateToRowById`
(
`rowId:string`
)
`=> Promise<void>`

Focuses a row identified by its row ID

`openColumnsSettings`() `=> Promise<void>`

Opens the column settings dropdown

`performRowAction`
(
`rowIndex:number,`
`actionName:string`
)
`=> Promise<void>`

Clicks a specific row action

`performRowActionById`
(
`rowId:string,`
`actionName:string`
)
`=> Promise<void>`

Clicks a specific row action on a row identified by its row ID

`pressEnterOnRow`
(
`rowIndex:number`
)
`=> Promise<void>`

Presses Enter key on a specific row

`pressEnterOnRowById`
(
`rowId:string`
)
`=> Promise<void>`

Presses Enter key on a row identified by its row ID

`refresh`() `=> Promise<void>`

Refreshes table data

`search`
(
`query:string`
)
`=> Promise<void>`

Performs a search in the table

`selectAllRows`() `=> Promise<void>`

Clicks the "select all" checkbox to select all rows

`selectRow`
(
`rowIndex:number`
)
`=> Promise<void>`

Selects a specific row by clicking its checkbox

`selectRowById`
(
`rowId:string`
)
`=> Promise<void>`

Selects a row identified by its row ID by clicking its checkbox

`sortByColumn`
(
`columnId:string`
)
`=> Promise<void>`

Sorts the table by clicking a column header

`toggleColumnVisibility`
(
`columnId:string`
)
`=> Promise<void>`

Toggles column visibility via the Columns button

DataTable

Usage

Test Helpers

DataTableTestHelpers

clearSearch() => Promise<void>

clickButton(buttonName:string | RegExp) => Promise<void>

clickRow(rowIndex:number) => Promise<void>

clickRowById(rowId:string) => Promise<void>

deselectAllRows() => Promise<void>

deselectRow(rowIndex:number) => Promise<void>

deselectRowById(rowId:string) => Promise<void>

getCell(rowIndex:number,columnId:string) => HTMLElement | null

getCellById(rowId:string,columnId:string) => HTMLElement | null

getCellContent(rowIndex:number,columnId:string) => string

getCellContentById(rowId:string,columnId:string) => string

getColumnHeaders() => string[]

getColumnOrder() => string[]

getErrorState() => boolean

getIsEmpty() => boolean

getIsRowSelected(rowIndex:number) => boolean

getIsRowSelectedById(rowId:string) => boolean

getLoadingIndicator() => HTMLElement | null

getRow(rowIndex:number) => HTMLElement | null

getRowActions(rowIndex:number) => string[]

getRowActionsById(rowId:string) => string[]

getRowById(rowId:string) => HTMLElement | null

getRowClickHandler(rowIndex:number) => boolean

getRowClickHandlerById(rowId:string) => boolean

getRowCount() => number

getRowData(rowIndex:number) => string[]

getRowDataById(rowId:string) => string[]

getRowHref(rowIndex:number) => string | null

getRowHrefById(rowId:string) => string | null

getSearchQuery() => string

getSelectedRowCount() => number

getVisibleColumns() => string[]

getVisibleRowCount() => number

goToNextPage() => Promise<void>

goToPreviousPage() => Promise<void>

hasButton(buttonName:string | RegExp) => boolean

hasNextPage() => boolean

hasPreviousPage() => boolean

hasRowActions(rowIndex:number) => boolean

hasRowActionsById(rowId:string) => boolean

hasSearchResults() => boolean

loadMore() => Promise<void>

loadNew() => Promise<void>

navigateToCell(rowIndex:number,columnIndex:number) => Promise<void>

navigateToCellById(rowId:string,columnIndex:number) => Promise<void>

navigateToRow(rowIndex:number) => Promise<void>

navigateToRowById(rowId:string) => Promise<void>

openColumnsSettings() => Promise<void>

performRowAction(rowIndex:number,actionName:string) => Promise<void>

performRowActionById(rowId:string,actionName:string) => Promise<void>

pressEnterOnRow(rowIndex:number) => Promise<void>

pressEnterOnRowById(rowId:string) => Promise<void>

refresh() => Promise<void>

search(query:string) => Promise<void>

selectAllRows() => Promise<void>

selectRow(rowIndex:number) => Promise<void>

selectRowById(rowId:string) => Promise<void>

sortByColumn(columnId:string) => Promise<void>

toggleColumnVisibility(columnId:string) => Promise<void>

On this page