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. | Beta |
| StatusBarManager | StatusBar Manager class. | Beta |
| 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. | |
| StatusBarContext | Context providing values for StatusFieldProps and MessageCenterFieldProps |
Global Functions
| Name | Description | |
|---|---|---|
| ClearEmphasisStatusField | Clear Emphasis StatusField | Beta |
| SectionsStatusField | Status Field for showing section extra tools for clearing and showing manipulators | Beta |
| StatusBarCenterSection | StatusBar Center Section React functional component | Beta |
| StatusBarComposer | Component to load components into the StatusBar. | Beta |
| StatusBarLeftSection | StatusBar Left Section React functional component | Beta |
| StatusBarRightSection | StatusBar Right Section React functional component | Beta |
| StatusBarSpaceBetween | StatusBar With Space Between Items React functional component | Beta |
| usePluginStatusBarItems | Hook that returns items from StatusBarItemsManager. | Beta |
| useStageStatusBarItems | Hook that returns items from StatusBarItemsManager. | Beta |
| withMessageCenterFieldProps | HOC that injects values for MessageCenterFieldProps. | Beta |
| withStatusFieldProps | HOC that injects values for StatusFieldProps. | Beta |
Interfaces
| Name | Description | |
|---|---|---|
| ConditionalFieldProps | Properties supported by ConditionalField component. | |
| SectionsStatusFieldProps | Sections Status Field Props | Beta |
| StatusBarComposerProps | Properties for the StatusBarComposer React components | Beta |
| StatusBarItem | Describes the data needed to insert an item into the StatusBar. | Beta |
| 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: 08 January, 2020