Interface: Widget¶

Defined in: packages/plugin-sdk/src/types/widget.ts:47

Methods¶

declareDataRequirements()¶

declareDataRequirements(): DataQuery[]

Defined in: packages/plugin-sdk/src/types/widget.ts:72

Declare what platform data this widget needs. The platform pre-fetches this data before calling render(), so render() receives fully populated WidgetData.queryResults without making any async calls.

Keep queries minimal — each declared query adds latency to the dashboard load.

Returns¶

DataQuery[]

declareSlot()¶

declareSlot(): WidgetSlotDeclaration

Defined in: packages/plugin-sdk/src/types/widget.ts:75

Declare which slot(s) this widget can render in.

Returns¶

WidgetSlotDeclaration

metadata()¶

metadata(): WidgetMetadata

Defined in: packages/plugin-sdk/src/types/widget.ts:48

Returns¶

WidgetMetadata

render()¶

render(data): string

Defined in: packages/plugin-sdk/src/types/widget.ts:63

Return a complete HTML document string to be served inside the widget iframe.

Security constraints: - Do not include