UXP
search
⌘Ctrlk
UXP
  • Getting Started
    • Setup Development Environment
    • Migration Setup
    • Create Your First View
    • Add Navigation and Validate
  • Understanding V5
    • V5 Architecture
    • Configuration Reference
  • Building Apps
    • Core UXP Components
    • Data Fetching
    • Events and Synchronization
    • External Components
    • Pluggable Views
  • Styling & Localization
    • Styling and Theming
    • Localization
  • Deployment
    • Build and Deploy
  • Best Practices
    • Best Practices
  • Introduction
    • Welcome
    • Understanding the Portal
    • Getting Started
  • Widget Development
    • Releasesarrow-up-right
    • Interface Types
    • Interface Guidelines
  • Integration
    • Interacting with Lucy
  • Styling
    • Interface Guidelines
    • Custom Styles and CSS
  • Publishing
    • Publishing your UIs
  • Tools
    • lucy-xp CLI
  • Additional Resources
    • UXP Releasesarrow-up-right
    • GitHub Repositoryarrow-up-right
    • Supportarrow-up-right
    • Components
    • Hooks
    • Types
      • Action
      • ActionResponse
      • ActionWithChildren
      • ActionsListProps
      • AddOnContextType
      • AddOnProviderProps
      • AdditionaDetails
      • AnalyticsCardProps
      • AnimationProps
      • AsyncButtonProps
      • AuditDeleteResult
      • BaseAction
      • BaseDetailsPanelConfig
      • BaseIconProps
      • BaseProps
      • BaseTableComponentProps
      • BreadcrumbItem
      • BreadcrumbProps
      • BreakPoint
      • ButtonComponentProps
      • ButtonComponentType
      • ButtonComponentVarient
      • ButtonGroupItem
      • ButtonGroupProps
      • ButtonIcon
      • ButtonProps
      • CRUDComponentInstanceProps
      • CRUDComponentProps
      • CachingOptions
      • CheckboxState
      • ChipProps
      • CollapseProps
      • Column
      • ComponentRendererProps
      • ComponentType
      • ConfiguredPage
      • ConfiguredPageComponentProps
      • CustomActionButton
      • CustomDetailsPanelProps
      • CustomFloatingAction
      • CustomNavigateFunction
      • CustomValidateResponse
      • CustomViewConfigs
      • DashboardFloatingActions
      • DashboardFloatingActionsControls
      • DashboardProps
      • DataEntryFieldProps
      • DataEntryFormHandlers
      • DataEntryFormProps
      • DataEntrySectionProps
      • DateRangePreset
      • DebounceHook
      • DefaultActionColumnsConfig
      • DefaultDetailsPanelProps
      • DeleteActionParams
      • DeleteActionProps
      • DetailsContent
      • DetailsPanelTab
      • DragState
      • DropPosition
      • DropdownHandlers
      • DropdownIndicatorProps
      • DropdownPosition
      • DropdownProps
      • DynamicFormFieldProps
      • DynamicFormHandlers
      • DynamicFormProps
      • EditableConfig
      • EditableRowConfig
      • EmbeddedDashobardComponentProps
      • EnhancedNavigateFunction
      • Environment
      • EventConfig
      • ExecuteAPIConfig
      • ExecuteActionConfig
      • ExecuteCollectionConfig
      • ExecuteConfig
      • ExecuteConfigBase
      • ExecuteMicroserviceConfig
      • ExecuteQueryConfig
      • ExecuteRequestConfig
      • ExecuteServiceConfig
      • ExecutionOptions
      • ExecutionResult
      • ExportColumnFormatter
      • ExtendedColumn
      • ExtendedFormProps
      • ExtendedFormatOptions
      • ExtendedTreeNode
      • FieldsHook
      • FilterConfig
      • FilterCustomRender
      • Filters
      • FloatingActionBaseProps
      • FloatingActionButtonVisibility
      • FloatingActionSection
      • FloatingActionSectionType
      • FontAwesomIconWrapperProps
      • FontAwesomeIconProps
      • FormProps
      • FormSectionProps
      • FormValue
      • FormatOptions
      • FullEventconfig
      • GenerateURLOptions
      • IAddOn
      • IAlertContent
      • IAlertFormField
      • IAlertResult
      • IAnimation
      • IAutoCompleteInputInstanceProps
      • IAutoCompleteInputProps
      • IBaseAlertProps
      • IButtonSize
      • IButtonType
      • IBuyOnSpaceworxButtonProps
      • ICalendarComponentProps
      • ICallback
      • ICheckboxInstanceProps
      • ICheckboxProps
      • ICheckboxType
      • ICircleBound
      • IColorPalletProps
      • IColorPickerPosition
      • IColorPickerProps
      • IColorTypes
      • IConfigPanelProps
      • IConfigurationViewProps
      • IConfigurationViewSection
      • IConfirmAlertProps
      • IConfirmButtonProps
      • IContentFunction
      • IContextProvider
      • ICustomThemes
      • IDataFunction
      • IDataGridProps
      • IDataItem
      • IDataListInstanceProps
      • IDataListProps
      • IDataTableColumn
      • IDataTableProps
      • IDatePickerOptions
      • IDatePickerProps
      • IDateRangePickerProps
      • IDateTimePickerProps
      • IDivIconInterface
      • IDropDownButtonPosition
      • IDropDownButtonProps
      • IDynamicSelectDataFunction
      • IDynamicSelectProps
      • IEventDispatcher
      • IEventSubscriber
      • IFileInputInstanceProps
      • IFileInputProps
      • IFilterPanelProps
      • IFormAlertProps
      • IFormData
      • IFormFeedbackProps
      • IFormFieldProps
      • IGaugeProps
      • IHSListProps
      • IHeatmapConfiguration
      • IHeatmapLayerProps
      • IHeatmapPoint
      • IIconButtonProps
      • IInputInstanceProps
      • IInputProps
      • IInputType
      • IInstalledAddOn
      • IItemCardProps
      • IItemListCardProps
      • ILabelProps
      • ILayout
      • ILinkButtonWidgetProps
      • ILinkWidgetContainerProps
      • ILocalisationFormModalInstanceProps
      • ILocalisationFormModalProps
      • ILocalisationFormProps
      • IMapComponentProps
      • IMarker
      • IModalProps
      • IModalWizardProps
      • IModalWizardStep
      • IModalWizardStepProps
      • IMultiSelectProps
      • INotificationProps
      • IOption
      • IPartialContent
      • IPartialContextProvider
      • IPieChartProps
      • IPolygonBound
      • IPopoverPosition
      • IPopoverProps
      • IPortalContainerProps
      • IPosition
      • IProfileImageProps
      • IRegion
      • IRemoveFunction
      • IRenderMarkerPopup
      • IRenderMarkerTooltip
      • IRenderUIItemProps
      • ISampleDataLabelProps
      • ISearchBoxInstanceProps
      • ISearchBoxProps
      • ISelectProps
      • ISimpleConfigurationTableProps
      • ISpaceworxDescriptionTagProps
      • ISpecialDate
      • IStaticImage
      • ITextAreaInstanceProps
      • ITextAreaProps
      • IThemeChangerProps
      • IThemeProps
      • ITimePickerProps
      • ITimeRangePickerProps
      • ITitleFunc
      • IToastContent
      • IToastFunction
      • IToastResult
      • IToggleFilterProps
      • IToggleOption
      • ITooltipPosition
      • ITooltipProps
      • ITreeViewLoaderProps
      • ITrendChartProps
      • ITrendData
      • ITrendSeries
      • ITrendSeriesType
      • IUXPFunctions
      • IUseEffectWithPolling
      • IUseUpdateWidgetProps
      • IWidget
      • IWidgetConfigs
      • IWidgetInstance
      • IWidgetPreloader
      • IWidgetPreloaderLoaderProps
      • IWidgetTitleBarProps
      • IWidgetWrapperProps
      • IWizardProps
      • IWizardStep
      • IWizardStepProps
      • IconPickerProps
      • IconProps
      • IconType
      • ImageIconProps
      • InfoCardData
      • InfoCardDetailsContent
      • InfoCardFields
      • InfoCardGroupInputProps
      • InfoCardGroupProps
      • InfoCardProps
      • InlineEditingMode
      • Language
      • ListProps
      • LoadingFeedbackProps
      • LucyQueryResult
      • MakeVisibleActionParams
      • MessageBusHook
      • MultiEventSubscriberConfig
      • NavigationLink
      • NoInteractionMode
      • OSCColumn
      • ObjectDetailsPanelBaseProps
      • ObjectDetailsPanelHandlers
      • ObjectDetailsPanelHeaderProps
      • ObjectDetailsPanelProps
      • ObjectField
      • ObjectInfoCardProps
      • ObjectSearchComponentHandlers
      • ObjectSearchComponentProps
      • ObjectSearchDetailsResponse
      • PHIconPrefix
      • PHIconProp
      • PHIconWeight
      • PHIconWrapperProps
      • PageFloatingActions
      • PaginationProps
      • ParsedIcon
      • PhosphorIconProps
      • PillComponentProps
      • PillConfiguration
      • PillOption
      • PillTypeConfig
      • PluggableViewDeclaration
      • Position
      • ProcessingOptions
      • ProfileProps
      • QRCodeComponentHandles
      • QRCodeComponentProps
      • QueryParams
      • RelativeDate
      • RenderCustomFormView
      • ResizeEffectHook
      • ResponsiveLayouts
      • ResponsiveWidgetLayoutConfiguration
      • RouterContextValue
      • Routes
      • RowData
      • RowInteractionMode
      • SafeLinkProps
      • ScriptCallback
      • SearchParams
      • Shape
      • SimpleEventConfig
      • SimpleFilter
      • SimpleTableBaseProps
      • SimpleTableDataArray
      • SimpleTableDataFunction
      • SimpleTableDataPaginated
      • SimpleTableProps
      • SimpleTableSearch
      • Size
      • SkeletonLoaderProps
      • SkeletonTableRowProps
      • SlideInFormBaseProps
      • SlideInFormDataEntryProps
      • SlideInFormDynamicProps
      • SlideInFormHandlers
      • SlideInFormProps
      • SlideInPanelDirection
      • SlideInPanelHandlers
      • SlideInPanelProps
      • Sort
      • SortOrder
      • SpacingMode
      • SystemDateFormat
      • SystemFormats
      • SystemTimeFormat
      • Tab
      • TabComponentProps
      • TabComponentStyles
      • TableCellProps
      • TableColumn
      • TableComponentProps
      • TableRowBasicProps
      • TableRowProps
      • TextIconProps
      • ThemeType
      • TimeRangeSliderPickerProps
      • ToolbarItem
      • TransitionProps
      • Tree
      • TreeNode
      • TreeNodeOptions
      • TreeViewCompareHandle
      • TreeViewCompareProps
      • TreeViewHandle
      • TreeViewProps
      • TreeViewSelectInputInstanceProps
      • TreeViewSelectInputProps
      • TreeViewStyles
      • UseCounterResponse
      • UseDeleteActionResult
      • UseDrawerItemsOptions
      • UseDrawerItemsReturn
      • UseExecuteOptions
      • UseExecuteResult
      • UseWidgetCacheOptions
      • UseWidgetCacheReturn
      • UseWidgetsReturn
      • UserDetailField
      • UserDetails
      • UserDetailsConfig
      • UserInfoCardDetails
      • UserInfoCardProps
      • View
      • ViewOverride
      • ViewsConfig
      • WidgetCategory
      • WidgetDrawerChangeEvent
      • WidgetDrawerConfig
      • WidgetDrawerMode
      • WidgetDrawerProps
      • WidgetDrawerStatus
      • WidgetDrawerType
gitbookPowered by GitBook
block-quoteOn this pagechevron-down
  1. Additional Resourceschevron-right
  2. Types

WidgetDrawerProps

hashtag
Definition

export interface WidgetDrawerProps {
    show: boolean
    onClose: () => void
    widgets: IWidgetInstance[]
    layouts: ResponsiveLayouts
    onChange: (event: WidgetDrawerChangeEvent) => boolean | Promise<boolean>
    isBounded?: boolean
    maxColumns?: number
    config?: WidgetDrawerConfig
}

hashtag
Usage

import { WidgetDrawerProps } from 'uxp/components';

hashtag
Related Types

  • 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

PreviousWidgetDrawerModechevron-leftNextWidgetDrawerStatuschevron-right

Last updated 1 month ago

  • Definition
  • Usage
  • Related Types