Widget
Classes for working with a Widget
Classes
| Name | Description | |
|---|---|---|
| StatusBarWidgetComposerControl | StatusBarWidgetComposerControl provides status bar to specified Frontstage that allows status bar items to be populated | Deprecated |
| WidgetControl | The base class for Widget controls. | Deprecated |
| WidgetDef | A Widget Definition in the 9-Zone Layout system. | |
| WidgetHost | A WidgetHost represents a definition that hosts one or most Widgets in a Frontstage. | |
| WidgetManager | Widget Manager class. | |
| WidgetStateChangedEvent | Widget State Changed Event class. | Deprecated |
Enumerations
| Name | Description | |
|---|---|---|
| WidgetState | Widget state enum. | |
| WidgetType | Widget type enum. |
Global Functions
| Name | Description | |
|---|---|---|
| BackstageAppButton | Component shown in the top-left corner of the content manipulation area. | |
| BasicNavigationWidget | Basic Navigation Widget that provides standard tools to manipulate views containing element data. | |
| BasicToolWidget | Default Tool Widget for standard "review" applications. | |
| ContentToolWidgetComposer | ContentToolWidgetComposer composes a Tool Widget with no tools defined by default. | |
| NavigationAidHost | Component that is used as a default navigation aid. | |
| NavigationWidgetComposer | Component that Composes a NavigationWidget typically using toolbars generated via ToolbarComposer class. | |
| ToolWidgetComposer | ToolWidget component that supports use of ToolbarComposer-based Toolbars. | |
| useActiveSendBackWidgetIdStore | ||
| useContainersStore | ||
| usePopoutsStore | ||
| useTransientState | Hook that allows to save and restore transient DOM state (i.e. | |
| useWidget | Hook that returns information about the Widget in the current context. | |
| useWidgetDirection | Returns widget direction. | |
| ViewToolWidgetComposer | ViewToolWidgetComposer composes a Navigation Widget with no tools defined by default. |
Interfaces
| Name | Description | |
|---|---|---|
| BackstageAppButtonProps | Properties of BackstageAppButton component. | |
| BasicNavigationWidgetProps | Properties that can be used to append items to the default set of toolbar items. | Deprecated |
| BasicToolWidgetProps | Properties that can be used to append items to the default set of toolbar items. | Deprecated |
| CanFloatWidgetOptions | Describes options of a floating widget. | |
| ContentToolWidgetComposerProps | Props for ContentToolWidgetComposer. | Deprecated |
| NavigationAidHostProps | Properties for the NavigationAidHost React component | Deprecated |
| NavigationWidgetComposerProps | Properties for the NavigationWidgetComposer React components | Deprecated |
| StandardLayoutWidget | Describes widget configuration specific to a standard layout. | |
| ToolWidgetComposerProps | Properties for the ToolWidgetComposer React components | Deprecated |
| ViewToolWidgetComposerProps | Props for ViewToolWidgetComposer. | Deprecated |
| Widget | Describes the data needed to provide a widget. | |
| WidgetConfig | Configuration from which a widget is created. | |
| WidgetLayouts | Describes widget configuration specific for each layout. | |
| WidgetStateChangedEventArgs | Widget State Changed Event Args interface. | Deprecated |
Last Updated: 24 June, 2025
Found something wrong, missing, or unclear on this page? Raise an issue in our repo.