Skip to content

useDispatchRequestUpdateOnFirstRender

Function: useDispatchRequestUpdateOnFirstRender()

taipy-gui JS module APIDocs


taipy-gui JS module API / useDispatchRequestUpdateOnFirstRender

useDispatchRequestUpdateOnFirstRender(dispatch, id?, context?, updateVars?, varName?, forceRefresh?): void

A React hook that requests an update for every dynamic property of the element.

Parameters

dispatch: Dispatch\<Action>

The React dispatcher associated to Context.

id?: string

The identifier of the element.

context?: string

The execution context.

updateVars?: string

The content of the property updateVars.

varName?: string

The default property backend provided variable (through property updateVarName).

forceRefresh?: boolean

Should Taipy re-evaluate the variables or use the current values.

Returns

void