Backstage

Classes for working with a Backstage

Classes

Name Description  
Backstage Backstage React component. Deprecated
BackstageEvent Backstage Event class. Deprecated
BackstageItemUtilities Utilities for creating and maintaining backstage items Beta
BackstageManager Controls backstage.  
CommandLaunchBackstageItem Backstage item that launches a Command Deprecated
FrontstageLaunchBackstageItem Backstage item that activates a Frontstage Deprecated
SeparatorBackstageItem Separator Backstage item. Deprecated

Enumerations

Name Description  
BackstageItemType Used to specify the item type added to the backstage menu. Deprecated

Global Functions

Name Description  
BackstageComposer Backstage component composed from BackstageManager items.  
getBackstageItemStateFromProps Helper method to set backstage item state from props. Deprecated
isBackstageActionItem BackstageActionItem type guard. Beta
isBackstageStageLauncher BackstageStageLauncher type guard. Beta
useBackstageManager Hook that returns backstage manager.  
useIsBackstageOpen Hook that returns isOpen flag of the backstage.  

Interfaces

Name Description  
BackstageActionItem Describes the data needed to insert an action button into the backstage menu. Beta
BackstageComposerProps Props of BackstageComposer component.  
BackstageEventArgs BackstageEvent arguments. Deprecated
BackstageItemProps Base properties for a Backstage item. Deprecated
BackstageItemState Properties that define the state of a Backstage items. Deprecated
BackstageProps Properties for the Backstage React component. Deprecated
BackstageStageLauncher Describes the data needed to insert an action button into the backstage menu. Beta
BackstageToggledArgs Arguments of Backstage.onToggled.  
CommandLaunchBackstageItemProps Properties for a CommandLaunchBackstageItem component Deprecated
FrameworkBackstage UiFramework.backstage interface.  
FrontstageLaunchBackstageItemProps Properties for a FrontstageLaunchBackstageItem component Deprecated

Type Aliases

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

Last Updated: 30 November, 2023