DataTables

column

The name of the column where this display component should be used.

component

The React component that will be rendered as the display. It receives the TanStack Table CellContext, including value, cell, row, and table.

pageId

The ID of the page where the data table is located, e.g. 'product-list', 'order-list'.

blockId

The ID of the data table block. Defaults to 'list-table', which is the default blockId for the standard list pages. However, some other pages may use a different blockId, such as 'product-variants-table' on the 'product-detail' page.

bulkActions

An array of additional bulk actions that will be available on the data table.

extendListDocument

Allows you to extend the list document for the data table.

displayComponents

Custom display components for specific columns in the data table.

viewOptionDefaults

Initial column visibility and order for this data table. These are applied as defaults before the user has interacted with the column settings — once a user customizes their view, their saved preferences take precedence over these values.

Use this to surface a custom field as a visible column out of the box, or to hide a column from a list view by default.