Skip to main content

DashboardDataTableExtensionDefinition

DashboardDataTableExtensionDefinition​

@vendure/dashboarddata-table.ts
v3.4.0

Status: Developer Preview

This allows you to customize aspects of existing data tables in the dashboard.

Signature
interface DashboardDataTableExtensionDefinition {
    pageId: string;
    blockId?: string;
    bulkActions?: BulkAction[];
    extendListDocument?: string | DocumentNode | (() => DocumentNode | string);
    displayComponents?: DashboardDataTableDisplayComponent[];
}

pageId​

property
string

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

blockId​

property
string

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​

property
BulkAction[]

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

extendListDocument​

property
string | DocumentNode | (() => DocumentNode | string)

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

displayComponents​

property
DashboardDataTableDisplayComponent[]

Custom display components for specific columns in the data table.