Skip to main content

DashboardExtension

DashboardExtension​

@vendure/dashboardextension-api-types.ts
v3.3.0

Status: Developer Preview

This is used to define the routes, widgets, etc. that will be displayed in the dashboard.

Signature
interface DashboardExtension {
    routes?: DashboardRouteDefinition[];
    navSections?: DashboardNavSectionDefinition[];
    pageBlocks?: DashboardPageBlockDefinition[];
    actionBarItems?: DashboardActionBarItem[];
    alerts?: DashboardAlertDefinition[];
    widgets?: DashboardWidgetDefinition[];
    customFormComponents?: DashboardCustomFormComponents;
    dataTables?: DashboardDataTableExtensionDefinition[];
    detailForms?: DashboardDetailFormExtensionDefinition[];
}

routes​

property
DashboardRouteDefinition[]

Allows you to define custom routes such as list or detail views.

property
DashboardNavSectionDefinition[]

Allows you to define custom nav sections for the dashboard.

pageBlocks​

property
DashboardPageBlockDefinition[]

Allows you to define custom page blocks for any page in the dashboard.

actionBarItems​

property
DashboardActionBarItem[]

Allows you to define custom action bar items for any page in the dashboard.

alerts​

property
DashboardAlertDefinition[]

Allows you to define custom alerts that can be displayed in the dashboard.

widgets​

property
DashboardWidgetDefinition[]

Allows you to define custom routes for the dashboard, which will render the given components and optionally also add a nav menu item.

customFormComponents​

property
DashboardCustomFormComponents

Unified registration for custom form components including custom field components, input components, and display components.

dataTables​

property
DashboardDataTableExtensionDefinition[]

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

detailForms​

property
DashboardDetailFormExtensionDefinition[]