Skip to content

@oneplatform/plugin-sdk


@oneplatform/plugin-sdk / WidgetData

Interface: WidgetData

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

Properties

config

config: Record\<string, unknown>

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

The widget instance's configuration values.


queryResults

queryResults: Record\<string, unknown[]>

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

Pre-fetched query results, keyed by entityType. Populated by the platform before render() is called. The platform fetches data using the tenant's access rights — widgets never make data API calls directly.


user

user: object

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

The requesting user's identity and roles. Use for conditional rendering only.

id

id: string

roles

roles: string[]