# Dashboard

## Installation

```tsx
import { Dashboard } from 'uxp/components';
```

## Signature

```tsx
const Dashboard: React.FunctionComponent<DashboardProps>
```

## Properties

| Name                 | Type                                                                                                                                                                                      | Mandatory | Default Value | Example Value |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- | ------------- | ------------- |
| widgets              | [IWidgetInstance\[\]](https://help.iviva.com/uxp/v5/additional-resources/types/iwidgetinstance)                                                                                           | Yes       | -             | -             |
| layouts              | [ResponsiveLayouts](https://help.iviva.com/uxp/v5/additional-resources/types/responsivelayouts)                                                                                           | No        | -             | -             |
| onSave               | (widgets: IWidgetInstance\[], layouts: ResponsiveLayouts) => Promise                                                                                                                      | Yes       | -             | -             |
| margin               | \[number, number]                                                                                                                                                                         | No        | -             | -             |
| padding              | \[number, number]                                                                                                                                                                         | No        | -             | -             |
| isEditing            | boolean                                                                                                                                                                                   | Yes       | -             | -             |
| allowRearrange       | boolean                                                                                                                                                                                   | No        | -             | -             |
| breakpoints          | Record\<string, BreakPoint>                                                                                                                                                               | No        | -             | -             |
| onChangeBreakPoint   | (cols: number) => void                                                                                                                                                                    | No        | -             | -             |
| showSpacerWidget     | boolean                                                                                                                                                                                   | No        | -             | -             |
| emptyPlaceholder     | { /\*\* \* Whether to show placeholder */ show?: boolean; /*\* \* Custom message to display */ message?: string; /*\* \* Callback when placeholder is clicked \*/ onClick?: () => void; } | No        | -             | -             |
| allowFreePositioning | boolean                                                                                                                                                                                   | No        | -             | -             |
| allowOverlap         | boolean                                                                                                                                                                                   | No        | -             | -             |
| isBounded            | boolean                                                                                                                                                                                   | No        | -             | -             |
| transformScale       | number                                                                                                                                                                                    | No        | -             | -             |
| onContainerMount     | (ref: HTMLDivElement) => void                                                                                                                                                             | No        | -             | -             |
| breakpointOverride   | string \| null                                                                                                                                                                            | No        | -             | -             |

## Related Types

* [DashboardProps](https://help.iviva.com/uxp/v5/additional-resources/types/dashboardprops)
* [IWidgetInstance](https://help.iviva.com/uxp/v5/additional-resources/types/iwidgetinstance)
* [ILayout](https://help.iviva.com/uxp/v5/additional-resources/types/ilayout)
* [IWidgetConfigs](https://help.iviva.com/uxp/v5/additional-resources/types/iwidgetconfigs)
* [DynamicFormFieldProps](https://help.iviva.com/uxp/v5/additional-resources/types/dynamicformfieldprops)
* [FormValue](https://help.iviva.com/uxp/v5/additional-resources/types/formvalue)
* [IFormData](https://help.iviva.com/uxp/v5/additional-resources/types/iformdata)
* [CustomValidateResponse](https://help.iviva.com/uxp/v5/additional-resources/types/customvalidateresponse)
* [FormSectionProps](https://help.iviva.com/uxp/v5/additional-resources/types/formsectionprops)
* [IConfigPanelProps](https://help.iviva.com/uxp/v5/additional-resources/types/iconfigpanelprops)
* [IContextProvider](https://help.iviva.com/uxp/v5/additional-resources/types/icontextprovider)
* [IPartialContextProvider](https://help.iviva.com/uxp/v5/additional-resources/types/ipartialcontextprovider)
* [Language](https://help.iviva.com/uxp/v5/additional-resources/types/language)
* [ICustomThemes](https://help.iviva.com/uxp/v5/additional-resources/types/icustomthemes)
* [IThemeProps](https://help.iviva.com/uxp/v5/additional-resources/types/ithemeprops)
* [ThemeType](https://help.iviva.com/uxp/v5/additional-resources/types/themetype)
* [UserDetails](https://help.iviva.com/uxp/v5/additional-resources/types/userdetails)
* [NavigationLink](https://help.iviva.com/uxp/v5/additional-resources/types/navigationlink)
* [Routes](https://help.iviva.com/uxp/v5/additional-resources/types/routes)
* [ConfiguredPage](https://help.iviva.com/uxp/v5/additional-resources/types/configuredpage)
* [ComponentType](https://help.iviva.com/uxp/v5/additional-resources/types/componenttype)
* [IUXPFunctions](https://help.iviva.com/uxp/v5/additional-resources/types/iuxpfunctions)
* [ViewOverride](https://help.iviva.com/uxp/v5/additional-resources/types/viewoverride)
* [Environment](https://help.iviva.com/uxp/v5/additional-resources/types/environment)
* [ExecutionOptions](https://help.iviva.com/uxp/v5/additional-resources/types/executionoptions)
* [CachingOptions](https://help.iviva.com/uxp/v5/additional-resources/types/cachingoptions)
* [IDataFunction](https://help.iviva.com/uxp/v5/additional-resources/types/idatafunction)
* [QueryParams](https://help.iviva.com/uxp/v5/additional-resources/types/queryparams)
* [ExecutionResult](https://help.iviva.com/uxp/v5/additional-resources/types/executionresult)
* [ExecuteMicroserviceConfig](https://help.iviva.com/uxp/v5/additional-resources/types/executemicroserviceconfig)
* [ExecuteConfigBase](https://help.iviva.com/uxp/v5/additional-resources/types/executeconfigbase)
* [LucyQueryResult](https://help.iviva.com/uxp/v5/additional-resources/types/lucyqueryresult)
* [IWidgetPreloader](https://help.iviva.com/uxp/v5/additional-resources/types/iwidgetpreloader)
* [ResponsiveLayouts](https://help.iviva.com/uxp/v5/additional-resources/types/responsivelayouts)
* [BreakPoint](https://help.iviva.com/uxp/v5/additional-resources/types/breakpoint)