API Reference › appui-react› Widget › WidgetDef

WidgetDef Class

A Widget Definition in the 9-Zone Layout system.

Methods

Name Description
constructor(): WidgetDef    
canOpen(): boolean    
expand(): void Opens the widget and expands it to fill full size of the stage panel.  
getWidgetControl(type: ConfigurableUiControlType): undefined | WidgetControl   Deprecated  
onWidgetStateChanged(): void    
restoreTransientState(): boolean Overwrite to restore transient DOM state.  
saveTransientState(): void Overwrite to save transient DOM state (i.e.  
setCanPopout(value: boolean): void    
setFloatingContainerId(value: string): void    
setLabel(labelSpec: string | StringGetter | ConditionalStringValue): void Set the label.  
setTooltip(v: string | StringGetter | ConditionalStringValue): void Set the tooltip.  
setWidgetState(newState: WidgetState): void    
show(): void Opens the widget and makes it visible to the user.  

Properties

Name Type Description
activeState Accessor ReadOnly WidgetState    
allowedPanelTargets Accessor undefined | ReadonlyArray<StagePanelLocation>    
allowedPanelTargets Setter allowedPanelTargets(targets: ReadonlyArray<StagePanelLocation>): void    
applicationData Accessor ReadOnly any    
badgeKind Accessor ReadOnly undefined | BadgeKind    
badgeType Accessor ReadOnly undefined | BadgeType    
canPopout Accessor ReadOnly undefined | boolean    
classId Accessor ReadOnly undefined | string | ConfigurableUiControlConstructor    
defaultState Accessor ReadOnly WidgetState    
floatingContainerId Accessor ReadOnly undefined | string    
hideWithUiWhenFloating Accessor boolean    
hideWithUiWhenFloating Setter hideWithUiWhenFloating(hide: boolean): void    
iconSpec Accessor IconSpec    
iconSpec Setter iconSpec(spec: IconSpec): void    
id Accessor ReadOnly string    
initialConfig Accessor ReadOnly undefined | WidgetConfig    
isActive Accessor ReadOnly boolean    
isFloating Accessor ReadOnly boolean    
isFloatingStateSupported Accessor ReadOnly boolean    
isFloatingStateWindowResizable Accessor ReadOnly boolean    
isStatusBar Accessor ReadOnly boolean    
isToolSettings Accessor ReadOnly boolean    
isVisible Accessor ReadOnly boolean    
label Accessor ReadOnly string Get the label string  
priority Accessor ReadOnly number    
reactNode Accessor React.ReactNode    
reactNode Setter reactNode(node: React.ReactNode): void    
state Accessor ReadOnly WidgetState    
stateChanged Accessor ReadOnly boolean    
tooltip Accessor ReadOnly string Get the tooltip string  
widgetControl Accessor ReadOnly undefined | WidgetControl    
widgetType Accessor WidgetType    
widgetType Setter widgetType(type: WidgetType): void    

Defined in

Last Updated: 24 June, 2025