Backstage

Classes for working with a Backstage

Classes

Name Description  
Backstage Backstage React component.  
BackstageComposer BackstageComposer React component. Beta
BackstageEvent Backstage Event class.  
BackstageItemManager Controls registering of BackstageItemProviders and calls the provider's methods when populating different parts of the User Interface. Beta
CommandLaunchBackstageItem Backstage item that launches a Command  
FrontstageLaunchBackstageItem Backstage item that activates a Frontstage  
SeparatorBackstageItem Separator Backstage item.  
TaskLaunchBackstageItem Backstage item that activates a Task  
UserProfileBackstageItem User Profile Backstage React component.  

Enumerations

Name Description  
BackstageItemType Used to specify the item type added to the backstage menu. Beta
BadgeType Specifies type of badge, if any, that should be overlaid on UI component. Beta
ConditionalDisplayType Used to specify if the UI item's visibility or enable state is affected by the testFunc defined in ConditionalDisplaySpecification. Beta

Global Functions

Name Description  
getBackstageItemStateFromProps Helper method to set backstage item state from props  

Interfaces

Name Description  
ActionItemSpec Describes the data needed to insert an action button into the backstage menu. Beta
BackstageEventArgs BackstageEvent arguments.  
BackstageItemProps Base properties for a Backstage item.  
BackstageItemProvider BackstageItemProvider Beta
BackstageItemProviderRegisteredEventArgs BackstageItemProvider Registered Event Args interface. Beta
BackstageItemSpec Describes the data needed to insert a button into the backstage menu. Beta
BackstageItemState Properties that define the state of a Backstage items.  
BackstageProps Properties for the Backstage React component.  
CommandLaunchBackstageItemProps Properties for a CommandLaunchBackstageItem component  
ConditionalDisplaySpecification Interface used to define a UI item whose display may change based on the current state of the application, such as the active view, the select element(s), etc. Beta
CustomItemSpec Describes the data needed to insert a custom item into the backstage menu. Beta
FrontstageLaunchBackstageItemProps Properties for a FrontstageLaunchBackstageItem component  
StageLauncher Describes the data needed to insert an action button into the backstage menu. Beta
TaskLaunchBackstageItemProps Properties for a TaskLaunchBackstageItem component  
UserProfileBackstageItemProps Properties for the Backstage React component.  

Last Updated: 20 September, 2019