Dashboard

Installation

import { Dashboard } from 'uxp/components';

Signature

const Dashboard: React.FunctionComponent<DashboardProps>

Properties

Name	Type	Mandatory	Default Value	Example Value
widgets	IWidgetInstance[]	Yes	-	-
layouts	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

• IWidgetInstance

• ILayout

• IWidgetConfigs

• DynamicFormFieldProps

• FormValue

• IFormData

• CustomValidateResponse

• FormSectionProps

• IConfigPanelProps

• IContextProvider

• IPartialContextProvider

• Language

• ICustomThemes

• IThemeProps

• ThemeType

• UserDetails

• NavigationLink

• Routes

• ConfiguredPage

• ComponentType

• IUXPFunctions

• ViewOverride

• Environment

• ExecutionOptions

• CachingOptions

• IDataFunction

• QueryParams

• ExecutionResult

• ExecuteMicroserviceConfig

• ExecuteConfigBase

• LucyQueryResult

• IWidgetPreloader

• ResponsiveLayouts

• BreakPoint