Skip to main content

Interface.TableProps

@standhigher/polaris-data-table

@standhigher/polaris-data-table / TableProps

Interface: TableProps<T>

Type Parameters​

T​

T extends object

Properties​

columns​

columns: readonly TableColumn<T>[]

visibleColumnKeys?​

optional visibleColumnKeys?: readonly string[]

Controlled visible column keys. Omit to render every declared column.

onVisibleColumnsChange?​

optional onVisibleColumnsChange?: (visibleColumnKeys) => void

Receives a sanitized column preference after the user changes visibility or the schema changes.

Parameters​

visibleColumnKeys​

readonly string[]

Returns​

void

requiredColumnKeys?​

optional requiredColumnKeys?: readonly string[]

Column keys that must remain visible whenever column visibility is controlled.

data​

data: readonly T[]

rowId​

rowId: Extract<keyof T, string> | ((row) => string)

query​

query: TableQuery

pagination​

pagination: TablePagination

formatOptions​

formatOptions: TableFormatOptions

filters?​

optional filters?: readonly TableFilterDefinition[]

selection​

selection: TableSelection

onSelectionChange​

onSelectionChange: (selection) => void

Parameters​

selection​

TableSelection

Returns​

void

onSelectAllMatching?​

optional onSelectAllMatching?: (query) => Promise<TableSelectAllMatchingResult>

Parameters​

query​

TableQuery

Returns​

Promise<TableSelectAllMatchingResult>

rowActions?​

optional rowActions?: readonly TableRowAction<T>[]

bulkActions?​

optional bulkActions?: readonly TableBulkAction[]

onFormatWarning?​

optional onFormatWarning?: (warning) => void

Parameters​

warning​

TableFormatWarning

Returns​

void

labels?​

optional labels?: Partial<TableLabels>

loading?​

optional loading?: boolean

error?​

optional error?: ReactNode

emptyState?​

optional emptyState?: ReactNode

onRetry?​

optional onRetry?: () => void

Returns​

void

onQueryChange​

onQueryChange: (query) => void

Parameters​

query​

TableQuery

Returns​

void