useDashboardLoader()

Home > @gooddata/sdk-ui-loaders > useDashboardLoader

useDashboardLoader() function

This hook encapsulates load, bootstrap and teardown of a dashboard enhanced by plugins.

Signature:

export declare function useDashboardLoader(options: IDashboardLoadOptions): DashboardLoadStatus;

Parameters

Parameter	Type	Description
options	IDashboardLoadOptions	load options

Returns:

DashboardLoadStatus

Remarks

It is a one-stop hook to use for React embedding of a Dashboard and when building new dashboard plugins.

See IDashboardLoadOptions.loadingMode to learn about loading modes