Widgets

Status: Developer Preview

Defines a dashboard widget that can be added to the dashboard.

Signature

type DashboardWidgetDefinition = {    id: string;    name: string;    component: React.ComponentType<DashboardBaseWidgetProps>;    defaultSize: { w: number; h: number; x?: number; y?: number };    minSize?: { w: number; h: number };    maxSize?: { w: number; h: number };}

id

propertystring

A unique identifier for the widget.

name

propertystring

The display name of the widget.

component

propertyReact.ComponentType<DashboardBaseWidgetProps>

The React component that renders the widget.

defaultSize

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

The default size and position of the widget.

minSize

property{ w: number; h: number }

The minimum size constraints for the widget.

maxSize

property{ w: number; h: number }

The maximum size constraints for the widget.