Skip to main content

Interface: RequestWidgetUpdateProps

Properties​

widgetName​

• widgetName: string

The name of the widget to update

renderWidget​

• renderWidget: (props: WidgetInfo) => Element | Promise<Element>

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

Type declaration​

▸ (props): Element | Promise<Element>

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

Parameters​
NameType
propsWidgetInfo
Returns​

Element | Promise<Element>

widgetNotFound​

• Optional widgetNotFound: () => void

Callback function that will be called if no widgets are added on the home screen It can be used to clean up background tasks that update the widget periodically

Type declaration​

▸ (): void

Callback function that will be called if no widgets are added on the home screen It can be used to clean up background tasks that update the widget periodically

Returns​

void