Classes for working with a Frontstage


Name Description  
Frontstage Frontstage React component. Deprecated
FrontstageActivatedEvent Frontstage Activated Event class.  
FrontstageComposer FrontstageComposer React component. Deprecated
FrontstageDeactivatedEvent Frontstage Deactivated Event class.  
FrontstageDef FrontstageDef class provides an API for a Frontstage.  
FrontstageManager Frontstage Manager class.  
FrontstageProvider Provides a definition required to create a Frontstage.  
FrontstageReadyEvent Frontstage Ready Event class.  
ModalFrontstage ModalFrontstage React component  
ModalFrontstageChangedEvent Modal Frontstage Stack Changed Event class.  
ModalFrontstageClosedEvent Modal Frontstage Closed Event class.  
NestedFrontstage Nested Frontstage related classes and commands  
PanelStateChangedEvent Panel State Changed Event class. Beta
SettingsModalFrontstage Modal frontstage displaying and editing settings from registered settings providers. Beta
StagePanel Frontstage Panel React component. Deprecated
StagePanelDef A StagePanelDef represents each Stage Panel within a Frontstage.  
StandardFrontstageProvider FrontstageProvider that provides an "empty" stage.  
ToolActivatedEvent Tool Activated Event class.  
ToolIconChangedEvent Tool Icon Changed Event class.  


Name Description  
SelectionScope Selection Scope enum.  
StagePanelState Enum for StagePanel state.  

Global Functions

Name Description  
useActiveFrontstageId Hook that returns active frontstage id.  
useSpecificWidgetDef Hook that returns the widgetDef for a specific widgetId within the active frontstage.  


Name Description  
FrontstageActivatedEventArgs Frontstage Activated Event Args interface.  
FrontstageConfig Configuration from which a frontstage is created. Beta
FrontstageDeactivatedEventArgs Frontstage Deactivated Event Args interface.  
FrontstageProps Properties for a Frontstage component. Deprecated
FrontstageReadyEventArgs Frontstage Ready Event Args interface.  
ModalFrontstageChangedEventArgs Modal Frontstage Changed Event Args interface.  
ModalFrontstageClosedEventArgs Modal Frontstage Closed Event Args interface.  
ModalFrontstageInfo Modal Frontstage information interface.  
ModalFrontstageProps Properties for the ModalFrontstage React component  
NineZoneChangeHandler Interface defining callbacks for nine zone changes Deprecated
PanelStateChangedEventArgs Panel State Changed Event Args interface.  
StagePanelChangeHandler Interface defining callbacks for stage panel changes Deprecated
StagePanelConfig Configuration from which a stage panel is created. Beta
StagePanelProps Properties of a StagePanel component Deprecated
StagePanelSectionsConfig Configuration from which stage panel sections are created. Beta
StagePanelZoneProps Properties of a Stage Panel Zone  
StagePanelZonesProps Properties of the Stage Panel Zones  
StandardFrontstageProps Props for StandardFrontstageProvider  
TargetChangeHandler Interface defining callbacks for ZoneDropTarget changes Deprecated
ToolActivatedEventArgs Tool Activated Event Args interface.  
ToolIconChangedEventArgs Tool Icon Changed Event Args interface.  
WidgetChangeHandler Interface defining callbacks for widget changes Deprecated
ZoneDefProvider Interface defining a provider for Zone definitions Deprecated

Type Aliases

Name Description  
StagePanelDefaultProps Default properties of StagePanel component. Deprecated
StagePanelMaxSizeSpec Available units of panel maximum size.  
StagePanelSectionConfig Configuration from which a stage panel section is created. Beta
WidgetPanelProps Properties of a WidgetPanelProps component  

Last Updated: 03 February, 2023