StatusBar
Classes for defining a StatusBar
Classes
| Name | Description | |
|---|---|---|
| StatusBar | Status Bar React component. | |
| StatusBarWidgetControl | Status Bar Widget Control. | |
| TileLoadingIndicator | TileLoadingIndicator React component | |
| ViewAttributesStatusField | Widget for showing Checkboxes for View Attributes | Beta |
Constants
| Name | Description | |
|---|---|---|
| SelectionInfoField | SelectionInfo Status Field React component. | |
| SelectionScopeField | SelectionScopeField React component. | |
| SnapModeField | Snap Mode Field React component. | |
| StatusBarField | Field component used in StatusBar component. | Beta |
Enumerations
| Name | Description | |
|---|---|---|
| StatusBarLabelSide | Defines which side of Icon where label is placed | |
| StatusBarSection | Status bar Groups/Sections from Left to Right |
Global Functions
| Name | Description | |
|---|---|---|
| isStatusBarActionItem | StatusBarActionItem type guard. | |
| isStatusBarCustomItem | StatusBarCustomItem type guard. | |
| isStatusBarLabelItem | StatusBarLabelItem 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. | |
| 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 | |
| StatusBarPopup | Popup component used in StatusBar component. | Beta |
| 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. |
Interfaces
| Name | Description | |
|---|---|---|
| CommonStatusBarItem | Describes the data needed to insert a button into the status bar. | |
| SectionsStatusFieldProps | Sections Status Field Props | Beta |
| StatusBarActionItem | Describes the data needed to insert an action item into the status bar. | |
| StatusBarComposerProps | Properties for the StatusBarComposer React components | |
| StatusBarCustomItem | Describes the data needed to insert an item into the StatusBar. | |
| StatusBarDialogProps | Properties of StatusBarDialog component. | Beta |
| StatusBarDialogTitleBarButtonProps | Properties of StatusBarDialogTitleBarButton component. | Beta |
| StatusBarDialogTitleBarProps | Properties of StatusBarDialogTitleBar component. | Beta |
| StatusBarFieldProps | Properties of StatusBarField component. | Beta |
| StatusBarIndicatorProps | Properties of StatusBarIndicator component. | Beta |
| StatusBarLabelIndicatorProps | Properties of StatusBarLabelIndicator component. | Beta |
| StatusBarLabelItem | Describes the data needed to insert a label item with an optional icon into the status bar. | |
| StatusBarProps | Properties for the StatusBar React component |
Namespaces
| Name | Description | |
|---|---|---|
| StatusBar | Components used in a StatusBar. | |
| StatusBarDialog | Components used in a StatusBarDialog. | Beta |
| StatusBarItemUtilities | Utility functions for creating and maintaining StatusBar items. |
Type Aliases
| Name | Description | |
|---|---|---|
| StatusBarFieldId | Status Bar Field type. | |
| StatusBarItem | Describes the data needed to insert a button into the status bar. |
Last Updated: 23 March, 2023