function
Guide: Embed a dashboard with plugins
Guide: useDashboardLoader
Source: useDashboardLoader.ts ↗
useDashboardLoader()
This hook encapsulates load, bootstrap and teardown of a dashboard enhanced by plugins.
export declare function useDashboardLoader(options: IDashboardLoadOptions): DashboardLoadStatus;
Parameters
Parameter | Type | Description |
|---|---|---|
options | load options |
Returns
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