WidgetConfig Interface

Configuration from which a widget is created.

Extends

Properties

Name Type Description
labelKey Readonly string | undefined If set, it is used to define a key that is used to look up a localized string.  
tooltipKey Readonly string | undefined If set, it is used to define a key that is used to look up a localized string.  

Inherited properties

Name Type Inherited from Description
allowedPanels Readonly | undefined Widget Stage panels to which this widget can be docked.
badge Readonly BadgeType | undefined Widget  
canFloat Readonly boolean | CanFloatWidgetOptions Widget Set to false to disable floating of a widget.
canPopout Readonly boolean | undefined Widget Describes if the widget can be popped out to a separate window.
content Readonly React.ReactNode | undefined Widget Content of the Widget.
defaultState Readonly WidgetState | undefined Widget Defaults to Floating if widget is not allowed to dock to any panels.
icon Readonly IconSpec | undefined Widget  
id Readonly string Widget  
label Readonly string | ConditionalStringValue Widget  
priority Readonly number | undefined Widget  
tooltip Readonly string | ConditionalStringValue Widget  

Defined in

Last Updated: 21 May, 2024