API Reference > appui-react > Widget

Widget

Classes for working with a Widget

Classes

Name Description  
DefaultNavigationWidget Default Navigation Widget for zone 3. Beta
NavigationWidget Navigation Widget React component. Deprecated
NavigationWidgetDef Definition of a Navigation Widget normally displayed in the top right zone in the 9-Zone Layout system. Deprecated
ReviewToolWidget Default Tool Widget for standard "review" applications. Beta
StatusBarWidgetComposerControl StatusBarWidgetComposerControl provides status bar to specified Frontstage that allows status bar items to be populated  
ToolbarWidgetDefBase A Toolbar Widget normally displayed in the top left & top right zones in the 9-Zone Layout system. Deprecated
ToolWidget ToolWidget React component. Deprecated
ToolWidgetDef Definition of a Tool Widget normally displayed in the top left zone in the 9-Zone Layout system. Deprecated
Widget Widget React component. Deprecated
WidgetControl The base class for Widget controls.  
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. Beta
WidgetStateChangedEvent Widget State Changed Event class.  

Constants

Name Description  
IModelConnectedNavigationWidget DefaultNavigationWidget that is connected to the IModelConnection property in the Redux store. Beta
WidgetState Widget state enum. Beta

Enumerations

Name Description  
WidgetType Widget type enum.  

Global Functions

Name Description  
BackstageAppButton BackstageAppButton used to toggle display of Backstage and is shown in the corner of the ToolWidget.  
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 NavigationAidHost is a component that hosts a NavigationAid that is specific to the active content control.  
NavigationWidgetComposer Component that Composes a NavigationWidget typically using toolbars generated via ToolbarComposer class.  
ToolWidgetComposer ToolWidget component that supports use of ToolbarComposer-based Toolbars.  
useTransientState Hook that allows to save and restore transient DOM state (i.e. Beta
ViewToolWidgetComposer ViewToolWidgetComposer composes a Navigation Widget with no tools defined by default.  

Interfaces

Name Description  
BackstageAppButtonProps Properties for the BackstageAppButton React component  
BasicNavigationWidgetProps Properties that can be used to append items to the default set of toolbar items of DefaultNavigationWidget.  
BasicToolWidgetProps Properties that can be used to append items to the default set of toolbar items of ReviewToolWidget.  
CommonWidgetProps Properties of a Widget. Beta
ContentToolWidgetComposerProps Props for ContentToolWidgetComposer.  
DefaultNavigationProps Properties that can be used to append items to the default set of toolbar items of DefaultNavigationWidget. Beta
NavigationAidHostProps Properties for the NavigationAidHost React component  
NavigationWidgetComposerProps Properties for the NavigationWidgetComposer React components  
NavigationWidgetProps Properties for a Navigation Widget. Deprecated
NavigationWidgetPropsEx Properties for the NavigationWidget React component. Deprecated
ReviewToolWidgetProps Properties that can be used to append items to the default set of toolbar items of ReviewToolWidget. Beta
ToolbarWidgetProps Properties for a Toolbar Widget. Deprecated
ToolWidgetComposerProps Properties for the ToolbarComposer React components  
ToolWidgetProps Properties for a Tool Widget. Deprecated
ToolWidgetPropsEx Properties for the ToolWidget React component. Deprecated
ViewToolWidgetComposerProps Props for ViewToolWidgetComposer.  
WidgetProps Properties for a Widget component. Deprecated
WidgetStateChangedEventArgs Widget State Changed Event Args interface.  

Type Aliases

Name Description  
AnyWidgetProps Union of all Widget properties. Deprecated
WidgetConfig Configuration from which a widget is created. Beta
WidgetState Widget state enum. Beta
WidgetStateFunc  

Last Updated: 30 November, 2023