Skip to main content

Interface: RequestWidgetUpdateByIdProps

Properties​

widgetName​

• widgetName: string

The name of the widget to update

widgetId​

• widgetId: number

The id of the widget to update

renderWidget​

• renderWidget: (props: WidgetInfo) => Element | { light: Element ; dark: null | Element } | Promise<WidgetRepresentation>

Callback function that will be called with WidgetInfo It should return the JSX of the updated widget

Type declaration​

▸ (props): Element | { light: Element ; dark: null | Element } | Promise<WidgetRepresentation>

Callback function that will be called with WidgetInfo It should return the JSX of the updated widget

Parameters​
NameType
propsWidgetInfo
Returns​

Element | { light: Element ; dark: null | Element } | Promise<WidgetRepresentation>

widgetNotFound​

• Optional widgetNotFound: () => void

Callback function that will be called if widget does not exist It can be used to clean up background tasks that update the widget periodically

Type declaration​

▸ (): void

Callback function that will be called if widget does not exist It can be used to clean up background tasks that update the widget periodically

Returns​

void