FrontstageProps Interface

Properties for a Frontstage component.

Extends

Properties

Name Type Description
applicationData undefined | any Any application data to attach to this Frontstage.  
bottomCenter undefined | ReactElement<ZoneProps, string | JSXElementConstructor<any>> The Zone along the bottom-center edge.  
bottomLeft undefined | ReactElement<ZoneProps, string | JSXElementConstructor<any>> The Zone in the bottom-left corner.  
bottomMostPanel undefined | ReactElement<StagePanelProps, string | JSXElementConstructor<any>> The StagePanel on the very bottom across the full width.  
bottomPanel undefined | ReactElement<StagePanelProps, string | JSXElementConstructor<any>> The StagePanel on the bottom of the 9-zone area.  
bottomRight undefined | ReactElement<ZoneProps, string | JSXElementConstructor<any>> The Zone in the bottom-right corner.  
centerLeft undefined | ReactElement<ZoneProps, string | JSXElementConstructor<any>> The Zone along the center-left edge.  
centerRight undefined | ReactElement<ZoneProps, string | JSXElementConstructor<any>> The Zone along the center-right edge.  
contentGroup string | ContentGroup The Content Group providing the Content Views  
contentManipulationTools undefined | ReactElement<ZoneProps, string | JSXElementConstructor<any>> The Zone in the top-left corner that shows tools typically used to query and modify content.  
defaultContentId undefined | string Id of the Content View to be activated initially  
defaultLayout string | ContentLayoutDef The default Content Layout used  
defaultTool ToolItemDef Tool that is started once the Frontstage is activated  
id string Id for the Frontstage  
isInFooterMode undefined | boolean Indicated whether the StatusBar is in footer mode or widget mode.  
leftPanel undefined | ReactElement<StagePanelProps, string | JSXElementConstructor<any>> The StagePanel on the left.  
rightPanel undefined | ReactElement<StagePanelProps, string | JSXElementConstructor<any>> The StagePanel on the right.  
statusBar undefined | ReactElement<ZoneProps, string | JSXElementConstructor<any>> The status bar Zone shown as the application footer.  
toolSettings undefined | ReactElement<ZoneProps, string | JSXElementConstructor<any>> The Zone the that shows settings for the active tool.  
topCenter undefined | ReactElement<ZoneProps, string | JSXElementConstructor<any>> The Zone along the top-center edge.  
topLeft undefined | ReactElement<ZoneProps, string | JSXElementConstructor<any>> The Zone in the top-left corner.  
topMostPanel undefined | ReactElement<StagePanelProps, string | JSXElementConstructor<any>> The StagePanel on the very top across the full width.  
topPanel undefined | ReactElement<StagePanelProps, string | JSXElementConstructor<any>> The StagePanel on the top of the 9-zone area.  
topRight undefined | ReactElement<ZoneProps, string | JSXElementConstructor<any>> The Zone in the top-right corner.  
usage undefined | string Usage type for this Frontstage.  
version undefined | number Frontstage version.  
viewNavigationTools undefined | ReactElement<ZoneProps, string | JSXElementConstructor<any>> The Zone in the top-right corner that shows view navigation tools.  

Inherited properties

Name Type Inherited from Description
className undefined | string CommonProps Custom CSS class name
style undefined | CSSProperties CommonProps Custom CSS style properties

Defined in

Last Updated: 11 June, 2024