usePlaceholders()

Home > @gooddata/sdk-ui > usePlaceholders

usePlaceholders() function

React hook to obtain/set multiple placeholder values at once.

Signature:

export declare function usePlaceholders<T extends IPlaceholder<any>[]>(placeholders: [...T]): [PlaceholdersValues<T>, (valueOrUpdateCallback: ValueOrUpdateCallback<PlaceholdersValues<T>>) => void];

Parameters

Parameter	Type	Description
placeholders	[...T]

Returns:

[PlaceholdersValues<T>, (valueOrUpdateCallback: ValueOrUpdateCallback<PlaceholdersValues<T>>) => void]

Remarks

This is useful to perform placeholders atomic change. See IPlaceholder.