Skip to main content

Interface.ExtensionTableProps

@standhigher/polaris-data-table

@standhigher/polaris-data-table / ExtensionTableProps

Interface: ExtensionTableProps<T>

Type Parameters​

T​

T extends object

Properties​

columns​

columns: readonly ExtensionTableColumn<T>[]

data​

data: readonly T[]

rowId​

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

host​

host: ExtensionTableHostContext

Required explicit host context; ExtensionTable never reads Admin routing or shop globals.

readOnly?​

optional readOnly?: boolean

compact?​

optional compact?: boolean

selectedRowId?​

optional selectedRowId?: string

onSelectionChange?​

optional onSelectionChange?: (rowId) => void

Parameters​

rowId​

string | undefined

Returns​

void

rowAction?​

optional rowAction?: ExtensionTableRowAction<T>

loading?​

optional loading?: boolean

error?​

optional error?: ReactNode

onRetry?​

optional onRetry?: () => void

Returns​

void

loadingState?​

optional loadingState?: ReactNode

emptyState?​

optional emptyState?: ReactNode

errorState?​

optional errorState?: (context) => ReactNode

Parameters​

context​
error​

ReactNode

onRetry?​

() => void

Returns​

ReactNode

hasMore?​

optional hasMore?: boolean

Cursor ownership stays in the host; this is intentionally unrelated to V1 offset pagination.

loadingMore?​

optional loadingMore?: boolean

onLoadMore?​

optional onLoadMore?: () => void | Promise<void>

Returns​

void | Promise<void>

labels?​

optional labels?: Partial<ExtensionTableLabels>