API Reference > ui-framework > Widget > WidgetProps

WidgetProps Interface

Properties for a Widget component.

Extends

Inherited methods

Name Inherited from Description
onWidgetStateChanged(): void OptionalReadonly Omit Handler for widget state changed event
restoreTransientState(): boolean OptionalReadonly Omit Restore transient DOM state.
saveTransientState(): void OptionalReadonly Omit Save transient DOM state (i.e.
stateFunc(state: Readonly<WidgetState>): WidgetState OptionalReadonly Omit Function executed to determine the state of the widget.

Properties

Name Type Description
classId string | ConfigurableUiControlConstructor Control's class id  
control undefined | ConfigurableUiControlConstructor A WidgetControl providing information about the Widget.  
element undefined | ReactNode A React component for the Widget.  
labelKey undefined | string if set, it is used to define a key that is used to look up a localized string.  
preferredPanelSize undefined | "fit-content"    
tooltipKey undefined | string 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
applicationData Readonly undefined | any Omit Application data attached to the Widget.
badgeType Readonly undefined | BadgeType Omit Badge to be overlaid on the widget tab.
canPopout Readonly undefined | boolean Omit Indicates if widget can be popped out to a child window.
className undefined | string IconProps Custom CSS class name
defaultState Readonly undefined | WidgetState Omit Default Widget state.
fillZone Readonly undefined | boolean Omit Indicates whether this Widget should fill the available space in the Zone.
icon Readonly string | ConditionalStringValue Omit Name of icon WebFont entry or if specifying an SVG symbol added by plug on use "svg:" prefix to imported symbol Id.
iconSpec undefined | IconSpec IconProps CSS class name or SvgSprite/SvgPath for icon
id Readonly undefined | string Omit Optional Id used to uniquely identify the widget.
internalData Readonly undefined | Map<string, any> Omit optional data to used by item implementor.
isFloatingStateSupported Readonly undefined | boolean Omit Indicates if widget can be in floating state.
isFloatingStateWindowResizable Readonly undefined | boolean Omit Indicates if floating widget is resizable.
isFreeform Readonly undefined | boolean Omit Indicates whether the Widget is free-form or rectangular.
isStatusBar Readonly undefined | boolean Omit Indicates whether this Widget is for the Status Bar.
isToolSettings Readonly undefined | boolean Omit Indicates whether this Widget is for the Tool Settings.
label Readonly string | ConditionalStringValue Omit if set, component will be considered selected but will NOT display an "active stripe" - defaults to false.
priority Readonly undefined | number Omit Widget priority
providerId Readonly undefined | string Omit id of UiItemsProvider
style undefined | CSSProperties IconProps Custom CSS style properties
syncEventIds Readonly undefined | string[] Omit Defines the SyncUi event Ids that will trigger the stateFunc to run to determine the state of the widget.
tooltip Readonly string | ConditionalStringValue Omit used to explicitly set the tooltip shown by a component.

Defined in

Last Updated: 11 June, 2024