Go Headless

Build Apps

Client

API Preview

Develop Websites

REST

Velo

GraphQL (Alpha)

# useDashboard

A React hook that provides access to the [Dashboard SDK](resourceId::b5088d52-82f9-44cc-b1a2-fea83606d85d*fallback::https://github.com/wix-private/developer-docs/blob/master/js-sdk-docs/dashboard/intro.md*original::../dashboard/intro.md) functions.

## Signature

```typescript
() => ReactSDK
```

## Returns

A `ReactSDK` object with the following functions:
+ [showToast](resourceId::b98f2137-aa4a-44cc-9ff3-b8adaa529e04*fallback::https://github.com/wix-private/developer-docs/blob/master/js-sdk-docs/dashboard/showToast.md*original::../dashboard/showToast.md)
+ [navigate](resourceId::ca6af4c5-b1e2-463c-ad40-6dc6e00ed61b*fallback::https://github.com/wix-private/developer-docs/blob/master/js-sdk-docs/dashboard/navigate.md*original::../dashboard/navigate.md)
+ [openModal](resourceId::8fce6bf5-515f-4a76-98f6-10e30f94158c*fallback::https://github.com/wix-private/developer-docs/blob/master/js-sdk-docs/dashboard/openModal.md*original::../dashboard/openModal.md)
+ [closeModal](resourceId::3f42f1d8-c1ab-43d3-87d5-15d655a5ad88*fallback::https://github.com/wix-private/developer-docs/blob/master/js-sdk-docs/dashboard/closeModal.md*original::../dashboard/closeModal.md)
+ [getPageUrl](resourceId::cfbd8cdc-d043-490a-bf74-dc7271b6fe49*fallback::https://github.com/wix-private/developer-docs/blob/master/js-sdk-docs/dashboard/getPageUrl.md*original::../dashboard/getPageUrl.md)
+ [onBeforeUnload](resourceId::956a0521-a0a1-4fd0-890d-9930dda83a2c*fallback::https://github.com/wix-private/developer-docs/blob/master/js-sdk-docs/dashboard/onBeforeUnload.md*original::../dashboard/onBeforeUnload.md)
+ [openMediaManager](resourceId::f89e4cd5-0f65-4e5e-98d6-5694933d17e2*fallback::https://github.com/wix-private/developer-docs/blob/master/js-sdk-docs/dashboard/openMediaManager.md*original::../dashboard/openMediaManager.md)


## Examples

To set up a dashboard client for React, refer to the [setup](resourceId::e31c05d0-6e37-4449-a9ca-e062c5d8c517#setup*fallback::https://github.com/wix-private/developer-docs/blob/master/js-sdk-docs/dashboard-react-sdk/intro.md#setup*original::./intro.md#setup) guide.

### Showing a toast
```tsx
import { withDashboard, useDashboard } from '@wix/dashboard-react';

export default withDashboard(() => {
    const { showToast } = useDashboard();
    const showToastOnClick = () => {
      showToast({ message: 'Hello World' });
    };
    
    return <button onClick={showToastOnClick}>Example</button>;
});
```