StatusBar

Classes for defining a StatusBar

Classes

Name Description  
ConditionalField A component that expects its children to be a function that will be passed the current component Props.  
FooterModeField A component that renders its children if the StatusBar is in Footer mode.  
Indicator General-purpose Footer indicator. Beta
StatusBar Status Bar React component.  
StatusBarItemsManager StatusBar Items Manager class. Beta
StatusBarItemUtilities Utility methods for creating and maintaining StatusBar items.  
StatusBarWidgetControl Status Bar Widget Control.  
TileLoadingIndicator TileLoadingIndicator React component Beta
ViewAttributesStatusField Widget for showing Checkboxes for View Attributes Beta

Constants

Name Description  
PromptField Prompt Field React component. Deprecated
SelectionInfoField SelectionInfo Status Field React component.  
SelectionScopeField SelectionScopeField React component.  
SnapModeField Snap Mode Field React component.  

Global Functions

Name Description  
ClearEmphasisStatusField Clear Emphasis StatusField Beta
isStatusBarItem StatusBarItem type guard.  
SectionsStatusField Status Field for showing section extra tools for clearing and showing manipulators Beta
StatusBarCenterSection StatusBar Center Section React functional component  
StatusBarComposer Component to load components into the StatusBar.  
StatusBarLeftSection StatusBar Left Section React functional component  
StatusBarRightSection StatusBar Right Section React functional component  
StatusBarSpaceBetween StatusBar With Space Between Items React functional component  
useDefaultStatusBarItems Hook that returns items from StatusBarItemsManager. Beta
useUiItemsProviderBackstageItems Hook that returns items from BackstageItemsManager. Beta
useUiItemsProviderStatusBarItems Hook that returns items from StatusBarItemsManager. Beta
withMessageCenterFieldProps HOC that injects values for MessageCenterFieldProps.  
withStatusFieldProps HOC that injects values for StatusFieldProps.  

Interfaces

Name Description  
ConditionalFieldProps Properties supported by ConditionalField component.  
FooterModeFieldProps Properties for a FooterModeField component  
SectionsStatusFieldProps Sections Status Field Props Beta
StatusBarComposerProps Properties for the StatusBarComposer React components  
StatusBarItem Describes the data needed to insert an item into the StatusBar.  
StatusBarProps Properties for the StatusBar React component  
StatusBarWidgetControlArgs Status Bar Widget Control render prop arguments.  
StatusFieldProps Properties for a StatusBar field component  

Type Aliases

Name Description  
StatusBarFieldId Status Bar Field type.  

Last Updated: 29 March, 2021