Overview of sdk-ui-loaders

Home > @gooddata/sdk-ui-loaders

sdk-ui-loaders package

This package provides various component loaders.

Remarks

Currently, there are loaders related to Dashboard embedding and Dashboard plugins. See also @gooddata/sdk-ui-dashboard.

Classes

Class	Description
DashboardLoader	Default implementation of the IDashboardLoader interface.

Functions

Function	Description
useDashboardLoader(options)	This hook encapsulates load, bootstrap and teardown of a dashboard enhanced by plugins.

Interfaces

Interface	Description
IDashboardBasePropsForLoader	This a specialization of IDashboardBaseProps interface in which the dashboard can only be provided by reference.
IDashboardLoader	Dashboard loader is responsible for loading dashboard and all the assets that the dashboard needs. As a result, it returns a React component and an instance of props to use in order to mount the dashboard.
IDashboardLoadOptions	Dashboard loading options.
IDashboardStubProps
IEmbeddedPlugin	Embedded plugin is implemented, built and linked into the application that loads the dashboard. There is no specific runtime loading and linkage required for these plugins.The lifecycle of embedded plugin is the same as other plugins

Variables

Variable	Description
DashboardStub	DashboardStub encapsulates load, bootstrap and teardown of a dashboard enhanced by plugins.

Type Aliases

Type Alias	Description
AdaptiveLoadOptions	Adaptive loading requires additional options passed by the client.
DashboardLoadingMode	Loading mode of the dashboard.
DashboardLoadResult	A result of successful load of a dashboard consists of a React component and constructed props that should be passed to the component in order to mount the dashboard.
DashboardLoadStatus	Returned by the useDashboardLoader to communicate the status of dashboard loading.
ModuleFederationIntegration	Module federation interop data.