API Reference › appui-react › Frontstage

Frontstage

Classes for working with a Frontstage

Classes

Name Description  
FrontstageActivatedEvent Frontstage Activated Event class.  
FrontstageDeactivatedEvent Frontstage Deactivated Event class.  
FrontstageDef FrontstageDef class provides an API for a Frontstage.  
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.  
SettingsModalFrontstage Modal frontstage displaying and editing settings from registered settings providers.  
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.  

Enumerations

Name Description  
SelectionScope Selection Scope enum.  
StagePanelLocation Available Stage Panel locations.  
StagePanelSection Enum for Stage Panel Sections  
StagePanelState Enum for StagePanel state.  

Global Functions

Name Description  
useActiveFrontstageDef Hook to return the active Frontstage def.  
useActiveFrontstageId Hook that returns active frontstage id.  
useSpecificWidgetDef Hook that returns the widgetDef for a specific widgetId within the active frontstage.  

Interfaces

Name Description  
FrameworkFrontstages UiFramework.frontstages interface  
FrontstageActivatedEventArgs Frontstage Activated Event Args interface.  
FrontstageConfig Configuration from which a frontstage is created.  
FrontstageDeactivatedEventArgs Frontstage Deactivated Event Args interface.  
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  
PanelPinnedChangedEventArgs Panel pinned changed event args interface.  
PanelStateChangedEventArgs Panel state changed event args interface.  
StagePanelConfig Configuration from which a stage panel is created.  
StagePanelSectionsConfig Configuration from which stage panel sections are created.  
StandardFrontstageProps Props for StandardFrontstageProvider  
ToolActivatedEventArgs Tool Activated Event Args interface.  
ToolIconChangedEventArgs Tool Icon Changed Event Args interface.  

Type Aliases

Name Description  
StagePanelMaxSizeSpec Available units of panel max size. Deprecated
StagePanelSectionConfig Configuration from which a stage panel section is created.  
StagePanelSizeSpec Available units of panel size - pixels or percentage of app size.  
WidgetPanelProps Properties of a WidgetPanelProps component  

Last Updated: 05 April, 2024