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. | Deprecated |
| 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 | |
| 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. | |
| StatusBarLabelSide | Defines which side of Icon where label is placed | Beta |
| StatusBarSection | Status bar Groups/Sections from Left to Right | Beta |
Global Functions
| Name | Description | |
|---|---|---|
| ClearEmphasisStatusField | Clear Emphasis StatusField | Beta |
| FooterModeField | A component that renders its children if the StatusBar is in Footer mode. | Deprecated |
| Indicator | General-purpose Footer indicator. | Deprecated |
| isStatusBarActionItem | StatusBarActionItem type guard. | Beta |
| isStatusBarCustomItem | StatusBarCustomItem type guard. | Beta |
| isStatusBarItem | StatusBarItem type guard. | Deprecated |
| isStatusBarLabelItem | StatusBarLabelItem type guard. | Beta |
| 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. | |
| StatusBarDialog | Dialog component used in a StatusBarIndicator component. | Beta |
| StatusBarDialogTitleBar | Dialog component used in a StatusBarDialog component. | Beta |
| StatusBarDialogTitleBarButton | Dialog component used in a StatusBarDialog component. | Beta |
| StatusBarIndicator | General-purpose StatusBar indicator. | Beta |
| StatusBarLabelIndicator | StatusBar indicator that shows a label with an icon. | Beta |
| StatusBarLeftSection | StatusBar Left Section React functional component | |
| StatusBarRightSection | StatusBar Right Section React functional component | |
| StatusBarSeparator | Component used to separate status fields in a status bar. | |
| StatusBarSpaceBetween | StatusBar With Space Between Items React functional component | |
| useDefaultStatusBarItems | Hook that returns items from StatusBarItemsManager. | |
| useUiItemsProviderBackstageItems | Hook that returns items from BackstageItemsManager. | |
| useUiItemsProviderStatusBarItems | Hook that returns items from StatusBarItemsManager. | |
| withMessageCenterFieldProps | HOC that injects values for MessageCenterFieldProps. | |
| withStatusFieldProps | HOC that injects values for StatusFieldProps. | Deprecated |
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 | |
| StatusBarDialogProps | Properties of StatusBarDialog component. | Beta |
| StatusBarDialogTitleBarButtonProps | Properties of StatusBarDialogTitleBarButton component. | Beta |
| StatusBarDialogTitleBarProps | Properties of StatusBarDialogTitleBar component. | Beta |
| StatusBarIndicatorProps | Properties of StatusBarIndicator component. | Beta |
| StatusBarItem | Describes the data needed to insert an item into the StatusBar. | Deprecated |
| StatusBarLabelIndicatorProps | Properties of StatusBarLabelIndicator component. | Beta |
| StatusBarProps | Properties for the StatusBar React component | |
| StatusBarWidgetControlArgs | Status Bar Widget Control render prop arguments. | |
| StatusFieldProps | Properties for a StatusBar field component |
Namespaces
| Name | Description | |
|---|---|---|
| StatusBarDialog | Components used in a StatusBarDialog. | Beta |
| StatusBarItemUtilities | Helper class to create Abstract StatusBar Item definitions. |
Type Aliases
| Name | Description | |
|---|---|---|
| AnyStatusBarItem | Describes the data needed to insert a button into the status bar. | Beta |
| CommonStatusBarItem | Describes the data needed to insert a button into the status bar. | Beta |
| StatusBarActionItem | Describes the data needed to insert an action item into the status bar. | Beta |
| StatusBarCustomItem | Describes the data needed to insert an item into the StatusBar. | Beta |
| StatusBarFieldId | Status Bar Field type. | |
| StatusBarLabelItem | Describes the data needed to insert a label item with an optional icon into the status bar. | Beta |
| StatusBarLabelSide | Defines which side of Icon where label is placed | Beta |
| StatusBarSection | Status bar Groups/Sections from Left to Right | Beta |
Last Updated: 20 June, 2023