API Reference > ui-framework > Widget > WidgetProps

WidgetProps Interface

Properties for a Widget component.

Extends

  • IconProps

Properties

Name Type Description
applicationData undefined | any Application data attached to the Widget.  
badgeType undefined | BadgeType Badge to be overlaid on the widget tab.  
betaBadge undefined | false | true Indicates whether to draw a Beta badge. Deprecated  
classId string | ConfigurableUiControlConstructor Control's class id  
control undefined | ConfigurableUiControlConstructor A WidgetControl providing information about the Widget.  
defaultState undefined | WidgetState Default Widget state.  
element undefined | React.ReactNode A React component for the Widget.  
fillZone undefined | false | true Indicates whether this Widget should fill the available space in the Zone.  
iconSpec string | React.ReactNode Specification for icon on Widget Tab  
id undefined | string Optional Id used to uniquely identify the widget.  
isFloatingStateSupported undefined | false | true Indicates if widget can be in floating state.  
isFloatingStateWindowResizable undefined | false | true Indicates if floating widget is resizable.  
isFreeform undefined | false | true Indicates whether the Widget is free-form or rectangular.  
isStatusBar undefined | false | true Indicates whether this Widget is for the Status Bar.  
isToolSettings undefined | false | true Indicates whether this Widget is for the Tool Settings.  
label string | StringGetter if set, component will be considered selected but will NOT display an "active stripe" - defaults to false.  
labelKey undefined | string if set, it is used to define a key that is used to look up a localized string.  
priority undefined | number Control's priority  
stateFunc undefined | (state: Readonly<WidgetState>) => WidgetState Function executed to determine the state of the widget.  
syncEventIds undefined | string[] Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget.  
tooltip string | StringGetter used to explicitly set the tooltip shown by a component.  
tooltipKey undefined | string if set, it is used to define a key that is used to look up a localized string.  

Defined in

Last Updated: 13 June, 2024