DashboardWidgetConfig

A configuration object for a dashboard widget.

Signature

interface DashboardWidgetConfig {    loadComponent: () => Promise<Type<any>> | Type<any>;    title?: string;    supportedWidths?: DashboardWidgetWidth[];    requiresPermissions?: string[];}

loadComponent

property() => Promise<Type<any>> | Type<any>

Used to specify the widget component. Supports both eager- and lazy-loading.

Example

// eager-loadingloadComponent: () => MyWidgetComponent,// lazy-loadingloadComponent: () => import('./path-to/widget.component').then(m => m.MyWidgetComponent),

title

propertystring

The title of the widget. Can be a translation token as it will get passed through the translate pipe.

supportedWidths

propertyDashboardWidgetWidth[]

The supported widths of the widget, in terms of a Bootstrap-style 12-column grid. If omitted, then it is assumed the widget supports all widths.

requiresPermissions

propertystring[]

If set, the widget will only be displayed if the current user has all the specified permissions.