> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# useDashboardLoader()

- Package: [@gooddata/sdk-ui-loaders](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/index.md)
- Kind: function
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-loaders/src/dashboard/useDashboardLoader.ts
- Guides: [Embed a dashboard with plugins](https://www.gooddata.ai/docs/gooddata-ui/latest/dashboard-plugins/embed-dashboard-with-plugins/index.md), [useDashboardLoader](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/hooks/use-dashboard-loader/index.md)

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

**Signature:**

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

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| options | [IDashboardLoadOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.idashboardloadoptions/index.md) | load options |

**Returns:**

[DashboardLoadStatus](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.dashboardloadstatus/index.md)

## Remarks

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

See [IDashboardLoadOptions.loadingMode](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-loaders/sdk-ui-loaders.idashboardloadoptions/index.md#idashboardloadoptionsloadingmode) to learn about loading modes
