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[];
    pageBlocks?: DashboardPageBlockDefinition[];
    actionBarItems?: DashboardActionBarItem[];
    alerts?: DashboardAlertDefinition[];
    widgets?: DashboardWidgetDefinition[];
}

routes​

property
DashboardRouteDefinition[]

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

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[]

Not yet implemented

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.