Skip to content

AssistantWidgetPart

AssistantWidgetPart = object

Defined in: packages/schema/src/assistant/protocol.ts:111

A part drawn by one of the app’s components, which fetches what it shows itself: the chat keeps only the component’s name and props such as { taskId }, so the part shows the record as it is now.

optional fallback?: object

Defined in: packages/schema/src/assistant/protocol.ts:121

Drawn, as a plain card, when the app has no component by that name: what the part was about when it was made.

optional body?: string

The card’s text.

title: string

The card’s title.


id: string

Defined in: packages/schema/src/assistant/protocol.ts:115

The part’s id, unique in its message; a part with the same id replaces it.


name: string

Defined in: packages/schema/src/assistant/protocol.ts:117

A component in the app’s components (its protobase.ui.tsx and the UI configs it extends), PascalCase.


props: Record<string, unknown>

Defined in: packages/schema/src/assistant/protocol.ts:119

JSON the component gets as props: ids and settings, not the state it shows. At most 2 KB.


type: "widget"

Defined in: packages/schema/src/assistant/protocol.ts:113

Marks a widget part.