Skip to main content

useWidgetsStore

Functions

removeWidgets()

removeWidgets(ids): void

Defined in: src/canvas/hooks/useWidgetsStore.ts:128

Parameters

ParameterType
idsstring[]

Returns

void


updateWidgetRender()

updateWidgetRender(id, widget, moduleBlobUrl, apisBlobUrl, settings?): void

Defined in: src/canvas/hooks/useWidgetsStore.ts:22

Parameters

ParameterType
idstring
widgetWidget
moduleBlobUrlstring
apisBlobUrlstring
settings?WidgetSettings

Returns

void


updateWidgetRenderError()

updateWidgetRenderError(id, error, message, apisBlobUrl, settings?): void

Defined in: src/canvas/hooks/useWidgetsStore.ts:62

Parameters

ParameterType
idstring
errorstring
messagestring
apisBlobUrlstring
settings?WidgetSettings

Returns

void


updateWidgetSettings()

updateWidgetSettings(id, settings, emit): void

Defined in: src/canvas/hooks/useWidgetsStore.ts:106

Parameters

ParameterTypeDefault value
idstringundefined
settingsPartial<WidgetSettings>undefined
emitbooleanfalse

Returns

void


useWidgetsStore()

Call Signature

useWidgetsStore(): object

Defined in: src/canvas/hooks/useWidgetsStore.ts:18

Returns

object

NameTypeDefined in
widgetsRecord<string, WidgetState>src/canvas/hooks/useWidgetsStore.ts:19

Call Signature

useWidgetsStore<U>(selector): U

Defined in: src/canvas/hooks/useWidgetsStore.ts:18

Type Parameters
Type Parameter
U
Parameters
ParameterType
selector(state) => U
Returns

U