Skip to main content

DashboardWidgetInstance

DashboardWidgetInstance​

@vendure/dashboardwidgets.ts
v3.3.0

Status: Developer Preview

Represents an instance of a dashboard widget with its layout and configuration.

Signature
type DashboardWidgetInstance = {
    id: string;
    widgetId: string;
    layout: {
        x: number;
        y: number;
        w: number;
        h: number;
    };
    config?: Record<string, unknown>;
}

id​

property
string

A unique identifier for the widget instance.

widgetId​

property
string

The ID of the widget definition this instance is based on.

layout​

property
{ x: number; y: number; w: number; h: number; }

The layout configuration for the widget.

config​

property
Record<string, unknown>

Optional configuration data for the widget.