Backstage

Classes for working with a Backstage

Classes

Name Description  
Backstage Backstage React component.  
BackstageEvent Backstage Event class.  
BackstageItemsManager Controls backstage items. Beta
BackstageManager Controls backstage. 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

Global Functions

Name Description  
BackstageComposer Backstage component composed from BackstageManager items. Beta
BackstageComposerItem Item of BackstageComposer. Beta
getBackstageItemStateFromProps Helper method to set backstage item state from props  
isActionItem BackstageActionItem type guard. Beta
isStageLauncher BackstageStageLauncher type guard. Beta
useBackstageItems Hook that returns items from BackstageItemsManager. Beta
useBackstageManager Hook that returns backstage manager. Beta
useIsBackstageOpen Hook that returns isOpen flag of the backstage. Beta

Interfaces

Name Description  
BackstageActionItem Describes the data needed to insert an action button into the backstage menu. Beta
BackstageComposerItemProps Props of BackstageComposerItem component. Beta
BackstageComposerProps Props of BackstageComposer component. Beta
BackstageEventArgs BackstageEvent arguments.  
BackstageItemProps Base properties for a Backstage item.  
BackstageItemsChangedArgs Arguments of BackstageItemsManager.onChanged event. Beta
BackstageItemState Properties that define the state of a Backstage items.  
BackstageProps Properties for the Backstage React component.  
BackstageStageLauncher Describes the data needed to insert an action button into the backstage menu. Beta
BackstageToggledArgs Arguments of BackstageManager.onToggled. Beta
CommandLaunchBackstageItemProps Properties for a CommandLaunchBackstageItem component  
CommonBackstageItem Describes the data needed to insert a button into the backstage menu. Beta
FrontstageLaunchBackstageItemProps Properties for a FrontstageLaunchBackstageItem component  
TaskLaunchBackstageItemProps Properties for a TaskLaunchBackstageItem component  
UserProfileBackstageItemProps Properties for the Backstage React component.  

Type Aliases

Name Description  
BackstageItem Describes the data needed to insert a button into the backstage menu. Beta

Last Updated: 01 November, 2019