WidgetDrawer

Widget drawer modal wrapper component that handles widget initialization internally

Installation

import { WidgetDrawer } from 'uxp/components';

Signature

const WidgetDrawer: React.FunctionComponent<WidgetDrawerProps>

Examples

tsx
<WidgetDrawer
  show={showDrawer}
  onClose={() => setShowDrawer(false)}
  widgets={dashboardWidgets}
  layouts={dashboardLayouts}
  onChange={(event) => {
    if (event.action === 'select') {
      // Raw selection (no layout processing)
      handleRawSelection(event.items)
    } else {
      // Add or delete (with layout processing)
      setWidgets(event.widgets!)
      setLayouts(event.layouts!)
    }
    return true
  }}
  config={{ mode: 'multi' }}
/>

Properties

Name	Type	Mandatory	Default Value	Example Value
show	boolean	Yes	-	-
onClose	() => void	Yes	-	-
widgets	IWidgetInstance[]	Yes	-	-
layouts	ResponsiveLayouts	Yes	-	-
onChange	(event: WidgetDrawerChangeEvent) => boolean | Promise	Yes	-	-
isBounded	boolean	No	-	-
maxColumns	number	No	-	-
config	WidgetDrawerConfig	No	-	-

Related Types

• WidgetDrawerProps

• 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

• WidgetDrawerChangeEvent

• IWidget

• IRenderUIItemProps

• WidgetDrawerType

• WidgetDrawerConfig

• WidgetDrawerMode

• WidgetDrawerStatus